diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 3ecb3bccc..0dca12265 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -7937,10 +7937,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -26799,6 +26796,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -62081,6 +62081,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -62207,7 +62210,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -62242,6 +62245,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -62249,6 +62255,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -62258,6 +62269,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -62286,7 +62309,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -75919,6 +75942,201 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -97673,6 +97891,99 @@ } } }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", @@ -97968,11 +98279,104 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -98039,7 +98443,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -98061,11 +98465,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -98132,7 +98536,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102905,6 +103309,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -136801,6 +137213,13 @@ "null" ] }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] + }, "secret-scanning-location": { "type": "object", "properties": { @@ -155943,6 +156362,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -156776,6 +157202,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -275156,6 +275589,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -275345,6 +275816,44 @@ "repository" ] }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", @@ -290724,6 +291233,27 @@ } } }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, "delete-budget": { "value": { "message": "Budget successfully deleted.", @@ -295450,21 +295980,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -311431,7 +311979,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } }, "secret-scanning-location-list": { @@ -316195,6 +316763,194 @@ } } }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "user-received-events-items": { "value": [ { @@ -319149,6 +319905,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "secret-scanning-alert-sort": { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 82cbd6278..dee2bdfa9 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -5605,9 +5605,7 @@ paths: in the budget examples: update-budget: - value: - message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -19347,6 +19345,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -45006,6 +45005,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -45085,6 +45085,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -45111,14 +45113,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -45136,7 +45150,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -54965,6 +54980,144 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -70451,6 +70604,72 @@ webhooks: supported-webhook-types: - repository - organization + secret-scanning-alert-assigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-assigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-created: post: summary: |- @@ -70794,6 +71013,72 @@ webhooks: - repository - organization - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-unassigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-validated: post: summary: |- @@ -74207,6 +74492,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -99037,6 +99329,12 @@ components: type: - string - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: + - string + - 'null' secret-scanning-location: type: object properties: @@ -113207,6 +113505,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113835,6 +114138,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -201843,6 +202151,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -201974,6 +202308,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -214376,6 +214736,22 @@ components: alert_recipients: - mona - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -218322,17 +218698,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -232098,6 +232486,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-location-list: value: - type: commit @@ -236209,6 +236616,138 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' user-received-events-items: value: - id: '22249084964' @@ -238814,6 +239353,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 3ecb3bccc..0dca12265 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -7937,10 +7937,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -26799,6 +26796,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -62081,6 +62081,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -62207,7 +62210,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -62242,6 +62245,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -62249,6 +62255,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -62258,6 +62269,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -62286,7 +62309,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -75919,6 +75942,201 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -97673,6 +97891,99 @@ } } }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", @@ -97968,11 +98279,104 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -98039,7 +98443,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -98061,11 +98465,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -98132,7 +98536,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102905,6 +103309,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -136801,6 +137213,13 @@ "null" ] }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] + }, "secret-scanning-location": { "type": "object", "properties": { @@ -155943,6 +156362,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -156776,6 +157202,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -275156,6 +275589,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -275345,6 +275816,44 @@ "repository" ] }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", @@ -290724,6 +291233,27 @@ } } }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, "delete-budget": { "value": { "message": "Budget successfully deleted.", @@ -295450,21 +295980,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -311431,7 +311979,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } }, "secret-scanning-location-list": { @@ -316195,6 +316763,194 @@ } } }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "user-received-events-items": { "value": [ { @@ -319149,6 +319905,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "secret-scanning-alert-sort": { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 82cbd6278..dee2bdfa9 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -5605,9 +5605,7 @@ paths: in the budget examples: update-budget: - value: - message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -19347,6 +19345,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -45006,6 +45005,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -45085,6 +45085,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -45111,14 +45113,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -45136,7 +45150,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -54965,6 +54980,144 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -70451,6 +70604,72 @@ webhooks: supported-webhook-types: - repository - organization + secret-scanning-alert-assigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-assigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-created: post: summary: |- @@ -70794,6 +71013,72 @@ webhooks: - repository - organization - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-unassigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-validated: post: summary: |- @@ -74207,6 +74492,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -99037,6 +99329,12 @@ components: type: - string - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: + - string + - 'null' secret-scanning-location: type: object properties: @@ -113207,6 +113505,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113835,6 +114138,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -201843,6 +202151,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -201974,6 +202308,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -214376,6 +214736,22 @@ components: alert_recipients: - mona - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -218322,17 +218698,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -232098,6 +232486,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-location-list: value: - type: commit @@ -236209,6 +236616,138 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' user-received-events-items: value: - id: '22249084964' @@ -238814,6 +239353,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index b8794fd6f..2a4582b0f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -5443,6 +5443,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6575,6 +6583,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7480,6 +7496,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7950,6 +7974,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10278,6 +10310,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11442,6 +11482,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12470,6 +12518,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13201,6 +13257,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -62593,7 +62657,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } } } @@ -117213,6 +117292,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -118360,6 +118447,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -160316,21 +160411,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -192534,6 +192647,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -375505,6 +375641,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -551499,6 +551643,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -554285,7 +554452,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -554360,6 +554527,13 @@ "string", "null" ] + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] } }, "anyOf": [ @@ -554367,6 +554541,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -554376,6 +554555,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -555625,7 +555816,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -555639,7 +555850,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -637273,6 +637484,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -696490,6 +696709,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -703951,51 +704178,732 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for user", - "description": "Get a specific field for a user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "name": "project_number", - "description": "The project's number.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.", + "name": "project_number", + "description": "The project's number.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { @@ -704202,21 +705110,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -765962,6 +766888,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -768741,6 +769674,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -897391,6 +898331,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -900498,6 +901446,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -903510,6 +904466,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -906522,6 +907486,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -909668,6 +910640,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -912821,6 +913801,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -917969,6 +918957,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1382840,206 +1383836,4337 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "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": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1384915,7 +1390042,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1384931,23 +1390058,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1385012,15 +1390137,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1386895,6 +1392204,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1386910,21 +1392220,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1386991,13 +1392299,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1389070,11 +1394378,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1389141,13 +1394449,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1389158,9 +1394466,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1389180,12 +1394485,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1389285,9 +1394584,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1389329,7 +1394625,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1391204,285 +1396501,1126 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "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": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": [ - "object", - "null" - ], - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1393359,8 +1399497,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1393374,21 +1399511,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1393453,184 +1399591,856 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "url": { - "type": "string", - "format": "uri" } - } - }, - "external_identifier": { - "type": "string" + ] }, - "external_reference": { + "resolution_comment": { "type": [ "string", "null" ], - "format": "uri" + "description": "An optional comment to resolve an alert." }, - "fix_reason": { - "type": "string" + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." }, - "fixed_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "fixed_in": { - "type": "string" + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "id": { - "type": "integer" + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "node_id": { - "type": "string" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "severity": { - "type": "string" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] } } @@ -1395510,8 +1402320,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1395525,21 +1402334,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1395604,7 +1402414,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1396458,96 +1403268,6 @@ } } }, - "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/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1396573,6 +1403293,354 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "examples": [ + "commit" + ] + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1398331,10 +1405399,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1398346,8 +1405589,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1398356,13 +1405600,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1398427,13 +1405671,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1399281,378 +1406525,120 @@ } } }, - "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "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/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, "id": { - "description": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", - "node_id" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1401412,185 +1408398,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1401602,9 +1408413,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1401613,11 +1408423,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1401684,13 +1408494,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1404436,11 +1411246,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1404507,13 +1411317,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1407259,11 +1414069,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1407330,13 +1414140,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1408184,6 +1414994,174 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0fb62e763..608bfc8c8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1073,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &613 + - &614 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -2343,6 +2343,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -11108,7 +11115,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &625 + sub_issues_summary: &626 title: Sub-issues Summary type: object properties: @@ -11129,7 +11136,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &626 + issue_dependencies_summary: &627 title: Issue Dependencies Summary type: object properties: @@ -11148,7 +11155,7 @@ paths: - total_blocking issue_field_values: type: array - items: &627 + items: &628 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11821,7 +11828,7 @@ paths: url: type: string format: uri - user: &639 + user: &640 title: Public User description: Public User type: object @@ -17179,7 +17186,19 @@ paths: update-budget: value: message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *23 '403': *27 @@ -17310,7 +17329,7 @@ paths: required: false schema: type: string - - &677 + - &678 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -17456,7 +17475,7 @@ paths: parameters: - *61 - *99 - - &678 + - &679 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -17568,7 +17587,7 @@ paths: - *99 - *101 - *100 - - &679 + - &680 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -17576,7 +17595,7 @@ paths: schema: type: string - *102 - - &680 + - &681 name: sku description: The SKU to query for usage. in: query @@ -21267,7 +21286,7 @@ paths: type: array items: *136 examples: - default: &642 + default: &643 value: total_count: 1 repositories: @@ -24205,12 +24224,12 @@ paths: required: - subject_digests examples: - default: &669 + default: &670 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &670 + withPredicateType: &671 value: subject_digests: - sha256:abc123 @@ -24269,7 +24288,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &671 + default: &672 value: attestations_subject_digests: - sha256:abc: @@ -33989,7 +34008,7 @@ paths: parameters: - *61 - *220 - - &654 + - &655 name: repo_name description: repo_name parameter in: path @@ -35048,7 +35067,7 @@ paths: - nuget - container - *61 - - &655 + - &656 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35089,7 +35108,7 @@ paths: default: *226 '403': *27 '401': *23 - '400': &657 + '400': &658 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -36915,7 +36934,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &728 + - &729 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -37816,7 +37835,7 @@ paths: - updated_at - project_url examples: - default: &674 + default: &675 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37948,7 +37967,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *243 - - &675 + - &676 name: field_id description: The unique identifier of the field. in: path @@ -37963,7 +37982,7 @@ paths: application/json: schema: *246 examples: - default: &676 + default: &677 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37972,17 +37991,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -42946,6 +42977,25 @@ paths: schema: type: string - &584 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &585 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -42960,7 +43010,7 @@ paths: - *46 - *19 - *17 - - &585 + - &586 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -42970,7 +43020,7 @@ paths: required: false schema: type: string - - &586 + - &587 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -42980,7 +43030,7 @@ paths: required: false schema: type: string - - &587 + - &588 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -42989,7 +43039,7 @@ paths: required: false schema: type: string - - &588 + - &589 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -42998,7 +43048,7 @@ paths: schema: type: boolean default: false - - &589 + - &590 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -43007,7 +43057,7 @@ paths: schema: type: boolean default: false - - &590 + - &591 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -43039,14 +43089,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &591 + state: &592 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &592 + resolution: &593 type: - string - 'null' @@ -43153,14 +43203,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &593 + - &594 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &595 + - &596 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -43217,7 +43267,7 @@ paths: - blob_url - commit_sha - commit_url - - &596 + - &597 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -43278,7 +43328,7 @@ paths: - page_url - commit_sha - commit_url - - &597 + - &598 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -43293,7 +43343,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &598 + - &599 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -43308,7 +43358,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &599 + - &600 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -43323,7 +43373,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &600 + - &601 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -43338,7 +43388,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &601 + - &602 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -43353,7 +43403,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &602 + - &603 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -43368,7 +43418,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &603 + - &604 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -43383,7 +43433,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &604 + - &605 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -43398,7 +43448,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &605 + - &606 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -43413,7 +43463,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &606 + - &607 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -43428,7 +43478,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &607 + - &608 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -43928,7 +43978,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 description: A repository security advisory. type: object properties: @@ -44247,7 +44297,7 @@ paths: - private_fork additionalProperties: false examples: - default: &612 + default: &613 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -46255,7 +46305,7 @@ paths: - updated_at - url examples: - default: &629 + default: &630 value: - author: login: octocat @@ -46503,7 +46553,7 @@ paths: application/json: schema: *298 examples: - default: &630 + default: &631 value: author: login: octocat @@ -46694,7 +46744,7 @@ paths: - updated_at - url examples: - default: &631 + default: &632 value: - author: login: octocat @@ -46920,7 +46970,7 @@ paths: application/json: schema: *301 examples: - default: &632 + default: &633 value: author: login: octocat @@ -47538,7 +47588,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &633 + response-if-user-is-a-team-maintainer: &634 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47603,7 +47653,7 @@ paths: application/json: schema: *308 examples: - response-if-users-membership-with-team-is-now-pending: &634 + response-if-users-membership-with-team-is-now-pending: &635 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47745,7 +47795,7 @@ paths: - updated_at - permissions examples: - default: &635 + default: &636 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47824,7 +47874,7 @@ paths: application/json: schema: *309 examples: - default: &636 + default: &637 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -48035,7 +48085,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &637 + schema: &638 title: Team Repository description: A team's access to a repository. type: object @@ -48764,7 +48814,7 @@ paths: type: array items: *172 examples: - response-if-child-teams-exist: &638 + response-if-child-teams-exist: &639 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -60213,7 +60263,7 @@ paths: check. type: array items: *390 - deployment: &689 + deployment: &690 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -65428,7 +65478,7 @@ paths: type: array items: *431 examples: - default: &645 + default: &646 value: total_count: 2 machines: @@ -68468,7 +68518,7 @@ paths: application/json: schema: type: array - items: &616 + items: &617 title: Status description: The status of a commit. type: object @@ -70067,7 +70117,7 @@ paths: items: type: object properties: - placeholder_id: &608 + placeholder_id: &609 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -75944,7 +75994,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &720 + last_response: &721 title: Hook Response type: object properties: @@ -77012,7 +77062,7 @@ paths: parameters: - *311 - *312 - - &666 + - &667 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77446,7 +77496,7 @@ paths: type: array items: *501 examples: - default: &659 + default: &660 value: - id: 1 repository: @@ -91366,15 +91416,16 @@ paths: - *582 - *583 - *584 + - *585 - *46 - *19 - *17 - - *585 - *586 - *587 - *588 - *589 - *590 + - *591 responses: '200': description: Response @@ -91382,7 +91433,7 @@ paths: application/json: schema: type: array - items: &594 + items: &595 type: object properties: number: *154 @@ -91398,8 +91449,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *591 - resolution: *592 + state: *592 + resolution: *593 resolved_at: type: - string @@ -91493,7 +91544,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *593 + - *594 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91641,13 +91692,13 @@ paths: - *311 - *312 - *410 - - *590 + - *591 responses: '200': description: Response content: application/json: - schema: *594 + schema: *595 examples: default: value: @@ -91689,6 +91740,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -91709,28 +91762,44 @@ paths: schema: type: object properties: - state: *591 - resolution: *592 + state: *592 + resolution: *593 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: + - string + - 'null' anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *594 + schema: *595 examples: default: value: @@ -91775,6 +91844,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -91782,7 +91870,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *97 x-github: enabledForGitHubApps: true @@ -91818,7 +91907,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &740 + items: &741 type: object properties: type: @@ -91845,7 +91934,6 @@ paths: - commit details: oneOf: - - *595 - *596 - *597 - *598 @@ -91858,6 +91946,7 @@ paths: - *605 - *606 - *607 + - *608 examples: default: value: @@ -91952,14 +92041,14 @@ paths: schema: type: object properties: - reason: &609 + reason: &610 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *608 + placeholder_id: *609 required: - reason - placeholder_id @@ -91976,7 +92065,7 @@ paths: schema: type: object properties: - reason: *609 + reason: *610 expire_at: type: - string @@ -92039,7 +92128,7 @@ paths: properties: incremental_scans: type: array - items: &610 + items: &611 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92067,15 +92156,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *610 + items: *611 backfill_scans: type: array - items: *610 + items: *611 custom_pattern_backfill_scans: type: array items: allOf: - - *610 + - *611 - type: object properties: pattern_name: @@ -92190,9 +92279,9 @@ paths: application/json: schema: type: array - items: *611 + items: *612 examples: - default: *612 + default: *613 '400': *14 '404': *6 x-github: @@ -92386,9 +92475,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: &614 + default: &615 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92735,7 +92824,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: default: value: @@ -92884,15 +92973,15 @@ paths: parameters: - *311 - *312 - - *613 + - *614 responses: '200': description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *614 + default: *615 '403': *27 '404': *6 x-github: @@ -92918,7 +93007,7 @@ paths: parameters: - *311 - *312 - - *613 + - *614 requestBody: required: true content: @@ -93089,10 +93178,10 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *614 - add_credit: *614 + default: *615 + add_credit: *615 '403': *27 '404': *6 '422': @@ -93132,7 +93221,7 @@ paths: parameters: - *311 - *312 - - *613 + - *614 responses: '202': *37 '400': *14 @@ -93161,7 +93250,7 @@ paths: parameters: - *311 - *312 - - *613 + - *614 responses: '202': description: Response @@ -93302,7 +93391,7 @@ paths: application/json: schema: type: array - items: &615 + items: &616 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93675,7 +93764,7 @@ paths: application/json: schema: type: array - items: *615 + items: *616 examples: default: value: @@ -93765,7 +93854,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -93859,7 +93948,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &617 + schema: &618 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93959,7 +94048,7 @@ paths: description: Response content: application/json: - schema: *617 + schema: *618 examples: default: value: @@ -94099,7 +94188,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Tag protection description: Tag protection type: object @@ -94180,7 +94269,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -94328,7 +94417,7 @@ paths: description: Response content: application/json: - schema: &619 + schema: &620 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94340,7 +94429,7 @@ paths: required: - names examples: - default: &620 + default: &621 value: names: - octocat @@ -94395,9 +94484,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *620 + default: *621 '404': *6 '422': *7 x-github: @@ -94420,7 +94509,7 @@ paths: parameters: - *311 - *312 - - &621 + - &622 name: per description: The time frame to display results for. in: query @@ -94451,7 +94540,7 @@ paths: - 128 clones: type: array - items: &622 + items: &623 title: Traffic type: object properties: @@ -94699,7 +94788,7 @@ paths: parameters: - *311 - *312 - - *621 + - *622 responses: '200': description: Response @@ -94720,7 +94809,7 @@ paths: - 3782 views: type: array - items: *622 + items: *623 required: - uniques - count @@ -95490,7 +95579,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &623 + text_matches: &624 title: Search Result Text Matches type: array items: @@ -95653,7 +95742,7 @@ paths: enum: - author-date - committer-date - - &624 + - &625 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -95773,7 +95862,7 @@ paths: type: number node_id: type: string - text_matches: *623 + text_matches: *624 required: - sha - node_id @@ -95965,7 +96054,7 @@ paths: - interactions - created - updated - - *624 + - *625 - *17 - *19 - name: advanced_search @@ -96062,11 +96151,11 @@ paths: type: - string - 'null' - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: type: string state_reason: @@ -96094,7 +96183,7 @@ paths: - string - 'null' format: date-time - text_matches: *623 + text_matches: *624 pull_request: type: object properties: @@ -96317,7 +96406,7 @@ paths: enum: - created - updated - - *624 + - *625 - *17 - *19 responses: @@ -96362,7 +96451,7 @@ paths: - 'null' score: type: number - text_matches: *623 + text_matches: *624 required: - id - node_id @@ -96447,7 +96536,7 @@ paths: - forks - help-wanted-issues - updated - - *624 + - *625 - *17 - *19 responses: @@ -96684,7 +96773,7 @@ paths: - admin - pull - push - text_matches: *623 + text_matches: *624 temp_clone_token: type: string allow_merge_commit: @@ -96992,7 +97081,7 @@ paths: - string - 'null' format: uri - text_matches: *623 + text_matches: *624 related: type: - array @@ -97185,7 +97274,7 @@ paths: - followers - repositories - joined - - *624 + - *625 - *17 - *19 responses: @@ -97295,7 +97384,7 @@ paths: type: - boolean - 'null' - text_matches: *623 + text_matches: *624 blog: type: - string @@ -97377,7 +97466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &628 + - &629 name: team_id description: The unique identifier of the team. in: path @@ -97418,7 +97507,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *628 + - *629 requestBody: required: true content: @@ -97519,7 +97608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *628 + - *629 responses: '204': description: Response @@ -97550,7 +97639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *628 + - *629 - *46 - *17 - *19 @@ -97563,7 +97652,7 @@ paths: type: array items: *298 examples: - default: *629 + default: *630 headers: Link: *52 x-github: @@ -97592,7 +97681,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *628 + - *629 requestBody: required: true content: @@ -97655,7 +97744,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *628 + - *629 - *300 responses: '200': @@ -97689,7 +97778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *628 + - *629 - *300 requestBody: required: false @@ -97715,7 +97804,7 @@ paths: application/json: schema: *298 examples: - default: *630 + default: *631 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97740,7 +97829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *628 + - *629 - *300 responses: '204': @@ -97770,7 +97859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *628 + - *629 - *300 - *46 - *17 @@ -97784,7 +97873,7 @@ paths: type: array items: *301 examples: - default: *631 + default: *632 headers: Link: *52 x-github: @@ -97813,7 +97902,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 requestBody: required: true @@ -97865,7 +97954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 responses: @@ -97900,7 +97989,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 requestBody: @@ -97926,7 +98015,7 @@ paths: application/json: schema: *301 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97951,7 +98040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 responses: @@ -97982,7 +98071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 - name: content @@ -98041,7 +98130,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 requestBody: @@ -98103,7 +98192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *628 + - *629 - *300 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -98161,7 +98250,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *628 + - *629 - *300 requestBody: required: true @@ -98220,7 +98309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -98258,7 +98347,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *628 + - *629 - name: role description: Filters members returned by their role in the team. in: query @@ -98309,7 +98398,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98346,7 +98435,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98386,7 +98475,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98423,7 +98512,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *628 + - *629 - *57 responses: '200': @@ -98432,7 +98521,7 @@ paths: application/json: schema: *308 examples: - response-if-user-is-a-team-maintainer: *633 + response-if-user-is-a-team-maintainer: *634 '404': *6 x-github: githubCloudOnly: false @@ -98465,7 +98554,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *628 + - *629 - *57 requestBody: required: false @@ -98493,7 +98582,7 @@ paths: application/json: schema: *308 examples: - response-if-users-membership-with-team-is-now-pending: *634 + response-if-users-membership-with-team-is-now-pending: *635 '403': description: Forbidden if team synchronization is set up '422': @@ -98527,7 +98616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98556,7 +98645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -98568,7 +98657,7 @@ paths: type: array items: *309 examples: - default: *635 + default: *636 headers: Link: *52 '404': *6 @@ -98594,7 +98683,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *628 + - *629 - *310 responses: '200': @@ -98603,7 +98692,7 @@ paths: application/json: schema: *309 examples: - default: *636 + default: *637 '404': description: Not Found if project is not managed by this team x-github: @@ -98627,7 +98716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *628 + - *629 - *310 requestBody: required: false @@ -98695,7 +98784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *628 + - *629 - *310 responses: '204': @@ -98723,7 +98812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -98765,7 +98854,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *628 + - *629 - *311 - *312 responses: @@ -98773,7 +98862,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *637 + schema: *638 examples: alternative-response-with-extra-repository-information: value: @@ -98924,7 +99013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *628 + - *629 - *311 - *312 requestBody: @@ -98976,7 +99065,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *628 + - *629 - *311 - *312 responses: @@ -99003,7 +99092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -99015,7 +99104,7 @@ paths: type: array items: *172 examples: - response-if-child-teams-exist: *638 + response-if-child-teams-exist: *639 headers: Link: *52 '404': *6 @@ -99048,7 +99137,7 @@ paths: application/json: schema: oneOf: - - &640 + - &641 title: Private User description: Private User type: object @@ -99298,7 +99387,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *639 + - *640 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99458,7 +99547,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -99856,7 +99945,7 @@ paths: type: integer secrets: type: array - items: &641 + items: &642 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99976,7 +100065,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -100122,7 +100211,7 @@ paths: type: array items: *136 examples: - default: *642 + default: *643 '401': *23 '403': *27 '404': *6 @@ -100389,7 +100478,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100442,7 +100531,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &644 + default: &645 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100487,9 +100576,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -100528,7 +100617,7 @@ paths: type: array items: *431 examples: - default: *645 + default: *646 '304': *35 '500': *96 '401': *23 @@ -101494,7 +101583,7 @@ paths: type: array items: *225 examples: - default: &656 + default: &657 value: - id: 197 name: hello_docker @@ -101595,7 +101684,7 @@ paths: application/json: schema: type: array - items: &646 + items: &647 title: Email description: Email type: object @@ -101665,9 +101754,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: &658 + default: &659 value: - email: octocat@github.com verified: true @@ -101744,7 +101833,7 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: default: value: @@ -102002,7 +102091,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: GPG Key description: A unique encryption key type: object @@ -102147,7 +102236,7 @@ paths: - subkeys - revoked examples: - default: &672 + default: &673 value: - id: 3 name: Octocat's GPG Key @@ -102232,9 +102321,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: &648 + default: &649 value: id: 3 name: Octocat's GPG Key @@ -102291,7 +102380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &649 + - &650 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102303,9 +102392,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: *648 + default: *649 '404': *6 '304': *35 '403': *27 @@ -102328,7 +102417,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *649 + - *650 responses: '204': description: Response @@ -102783,7 +102872,7 @@ paths: application/json: schema: type: array - items: &650 + items: &651 title: Key description: Key type: object @@ -102886,9 +102975,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: &651 + default: &652 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102927,9 +103016,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: *651 + default: *652 '404': *6 '304': *35 '403': *27 @@ -102985,7 +103074,7 @@ paths: application/json: schema: type: array - items: &652 + items: &653 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103064,7 +103153,7 @@ paths: - account - plan examples: - default: &653 + default: &654 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103126,9 +103215,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: *653 + default: *654 headers: Link: *52 '304': *35 @@ -104132,7 +104221,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *220 - - *654 + - *655 responses: '204': description: Response @@ -104247,7 +104336,7 @@ paths: - docker - nuget - container - - *655 + - *656 - *19 - *17 responses: @@ -104259,8 +104348,8 @@ paths: type: array items: *225 examples: - default: *656 - '400': *657 + default: *657 + '400': *658 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104289,7 +104378,7 @@ paths: application/json: schema: *225 examples: - default: &673 + default: &674 value: id: 40201 name: octo-name @@ -104651,9 +104740,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: *658 + default: *659 headers: Link: *52 '304': *35 @@ -104766,7 +104855,7 @@ paths: type: array items: *64 examples: - default: &665 + default: &666 summary: Default response value: - id: 1296269 @@ -105126,7 +105215,7 @@ paths: type: array items: *501 examples: - default: *659 + default: *660 headers: Link: *52 '304': *35 @@ -105205,7 +105294,7 @@ paths: application/json: schema: type: array - items: &660 + items: &661 title: Social account description: Social media account type: object @@ -105222,7 +105311,7 @@ paths: - provider - url examples: - default: &661 + default: &662 value: - provider: twitter url: https://twitter.com/github @@ -105285,9 +105374,9 @@ paths: application/json: schema: type: array - items: *660 + items: *661 examples: - default: *661 + default: *662 '422': *15 '304': *35 '404': *6 @@ -105375,7 +105464,7 @@ paths: application/json: schema: type: array - items: &662 + items: &663 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105395,7 +105484,7 @@ paths: - title - created_at examples: - default: &681 + default: &682 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105460,9 +105549,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: &663 + default: &664 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105492,7 +105581,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &664 + - &665 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105504,9 +105593,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *663 + default: *664 '404': *6 '304': *35 '403': *27 @@ -105529,7 +105618,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *664 + - *665 responses: '204': description: Response @@ -105558,7 +105647,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &682 + - &683 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -105583,11 +105672,11 @@ paths: type: array items: *64 examples: - default-response: *665 + default-response: *666 application/vnd.github.v3.star+json: schema: type: array - items: &683 + items: &684 title: Starred Repository description: Starred Repository type: object @@ -105956,10 +106045,10 @@ paths: application/json: schema: oneOf: + - *641 - *640 - - *639 examples: - default-response: &667 + default-response: &668 summary: Default response value: login: octocat @@ -105994,7 +106083,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &668 + response-with-git-hub-plan-information: &669 summary: Response with GitHub plan information value: login: octocat @@ -106116,7 +106205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *666 + - *667 - *17 responses: '200': @@ -106165,11 +106254,11 @@ paths: application/json: schema: oneOf: + - *641 - *640 - - *639 examples: - default-response: *667 - response-with-git-hub-plan-information: *668 + default-response: *668 + response-with-git-hub-plan-information: *669 '404': *6 x-github: githubCloudOnly: false @@ -106219,8 +106308,8 @@ paths: required: - subject_digests examples: - default: *669 - withPredicateType: *670 + default: *670 + withPredicateType: *671 responses: '200': description: Response @@ -106274,7 +106363,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *671 + default: *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106520,7 +106609,7 @@ paths: type: array items: *225 examples: - default: *656 + default: *657 '403': *27 '401': *23 x-github: @@ -106904,9 +106993,9 @@ paths: application/json: schema: type: array - items: *647 + items: *648 examples: - default: *672 + default: *673 headers: Link: *52 x-github: @@ -107135,7 +107224,7 @@ paths: - docker - nuget - container - - *655 + - *656 - *57 - *19 - *17 @@ -107148,10 +107237,10 @@ paths: type: array items: *225 examples: - default: *656 + default: *657 '403': *27 '401': *23 - '400': *657 + '400': *658 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107181,7 +107270,7 @@ paths: application/json: schema: *225 examples: - default: *673 + default: *674 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107530,7 +107619,7 @@ paths: type: array items: *246 examples: - default: *674 + default: *675 headers: Link: *52 '304': *35 @@ -107541,6 +107630,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - *57 + - *243 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *246 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *35 + '403': *27 + '401': *23 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -107553,7 +107893,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *243 - - *675 + - *676 - *57 responses: '200': @@ -107562,7 +107902,7 @@ paths: application/json: schema: *246 examples: - default: *676 + default: *677 headers: Link: *52 '304': *35 @@ -108096,7 +108436,7 @@ paths: - *99 - *101 - *100 - - *677 + - *678 - *102 responses: '200': @@ -108227,7 +108567,7 @@ paths: parameters: - *57 - *99 - - *678 + - *679 - *100 responses: '200': @@ -108326,9 +108666,9 @@ paths: - *99 - *101 - *100 - - *679 - - *102 - *680 + - *102 + - *681 responses: '200': description: Response when getting a billing usage summary @@ -108462,9 +108802,9 @@ paths: application/json: schema: type: array - items: *660 + items: *661 examples: - default: *661 + default: *662 headers: Link: *52 x-github: @@ -108494,9 +108834,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: *681 + default: *682 headers: Link: *52 x-github: @@ -108521,7 +108861,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *57 - - *682 + - *683 - *46 - *17 - *19 @@ -108533,11 +108873,11 @@ paths: schema: anyOf: - type: array - items: *683 + items: *684 - type: array items: *64 examples: - default-response: *665 + default-response: *666 headers: Link: *52 x-github: @@ -108697,7 +109037,7 @@ webhooks: type: string enum: - disabled - enterprise: &684 + enterprise: &685 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108766,7 +109106,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &685 + installation: &686 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108787,7 +109127,7 @@ webhooks: required: - id - node_id - organization: &686 + organization: &687 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108860,7 +109200,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &687 + repository: &688 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -109773,10 +110113,10 @@ webhooks: type: string enum: - enabled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -109852,11 +110192,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: &688 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + rule: &689 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -110079,11 +110419,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + rule: *689 sender: *4 required: - action @@ -110271,11 +110611,11 @@ webhooks: - everyone required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + rule: *689 sender: *4 required: - action @@ -110359,7 +110699,7 @@ webhooks: type: string enum: - completed - check_run: &690 + check_run: &691 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110469,7 +110809,7 @@ webhooks: - examples: - neutral - deployment: *689 + deployment: *690 details_url: type: string examples: @@ -110567,10 +110907,10 @@ webhooks: - output - app - pull_requests - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 sender: *4 required: - check_run @@ -110963,11 +111303,11 @@ webhooks: type: string enum: - created - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *691 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 sender: *4 required: - check_run @@ -111363,11 +111703,11 @@ webhooks: type: string enum: - requested_action - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *691 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 requested_action: description: The action requested by the user. type: object @@ -111772,11 +112112,11 @@ webhooks: type: string enum: - rerequested - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *691 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 sender: *4 required: - check_run @@ -112768,10 +113108,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -113052,6 +113392,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113471,10 +113816,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -113750,6 +114095,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -114168,10 +114518,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -114492,20 +114842,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &691 + commit_oid: &692 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *684 - installation: *685 - organization: *686 - ref: &692 + enterprise: *685 + installation: *686 + organization: *687 + ref: &693 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *687 + repository: *688 sender: *4 required: - action @@ -114913,12 +115263,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -115201,12 +115551,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -115552,12 +115902,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -115840,9 +116190,9 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115850,7 +116200,7 @@ webhooks: type: - string - 'null' - repository: *687 + repository: *688 sender: *4 required: - action @@ -116096,12 +116446,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -116363,10 +116713,10 @@ webhooks: - updated_at - author_association - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -116447,18 +116797,18 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *686 - pusher_type: &693 + organization: *687 + pusher_type: &694 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &694 + ref: &695 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116468,7 +116818,7 @@ webhooks: enum: - tag - branch - repository: *687 + repository: *688 sender: *4 required: - ref @@ -116551,9 +116901,9 @@ webhooks: enum: - created definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116638,9 +116988,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116718,9 +117068,9 @@ webhooks: enum: - promote_to_enterprise definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116798,9 +117148,9 @@ webhooks: enum: - updated definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116877,10 +117227,10 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - repository: *687 - organization: *686 + enterprise: *685 + installation: *686 + repository: *688 + organization: *687 sender: *4 new_property_values: type: array @@ -116965,18 +117315,18 @@ webhooks: title: delete event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - pusher_type: *693 - ref: *694 + enterprise: *685 + installation: *686 + organization: *687 + pusher_type: *694 + ref: *695 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *687 + repository: *688 sender: *4 required: - ref @@ -117061,10 +117411,10 @@ webhooks: enum: - auto_dismissed alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117149,10 +117499,10 @@ webhooks: enum: - auto_reopened alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117237,10 +117587,10 @@ webhooks: enum: - created alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117323,10 +117673,10 @@ webhooks: enum: - dismissed alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117409,10 +117759,10 @@ webhooks: enum: - fixed alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117496,10 +117846,10 @@ webhooks: enum: - reintroduced alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117582,10 +117932,10 @@ webhooks: enum: - reopened alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117662,9 +118012,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - key: &695 + enterprise: *685 + installation: *686 + key: &696 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117702,8 +118052,8 @@ webhooks: - verified - created_at - read_only - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -117780,11 +118130,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - key: *695 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + key: *696 + organization: *687 + repository: *688 sender: *4 required: - action @@ -118356,12 +118706,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: &699 + workflow: &700 title: Workflow type: - object @@ -119103,9 +119453,9 @@ webhooks: pull_requests: type: array items: *547 - repository: *687 - organization: *686 - installation: *685 + repository: *688 + organization: *687 + installation: *686 sender: *4 responses: '200': @@ -119176,7 +119526,7 @@ webhooks: type: string enum: - approved - approver: &696 + approver: &697 type: object properties: avatar_url: @@ -119219,11 +119569,11 @@ webhooks: type: string comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: &697 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + reviewers: &698 type: array items: type: object @@ -119304,7 +119654,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &698 + workflow_job_run: &699 type: object properties: conclusion: @@ -120050,18 +120400,18 @@ webhooks: type: string enum: - rejected - approver: *696 + approver: *697 comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: *697 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + reviewers: *698 sender: *4 since: type: string - workflow_job_run: *698 + workflow_job_run: *699 workflow_job_runs: type: array items: @@ -120778,13 +121128,13 @@ webhooks: type: string enum: - requested - enterprise: *684 + enterprise: *685 environment: type: string - installation: *685 - organization: *686 - repository: *687 - requestor: &704 + installation: *686 + organization: *687 + repository: *688 + requestor: &705 title: User type: - object @@ -122727,12 +123077,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Deployment Workflow Run type: @@ -123423,7 +123773,7 @@ webhooks: type: string enum: - answered - answer: &702 + answer: &703 type: object properties: author_association: @@ -123583,7 +123933,7 @@ webhooks: - created_at - updated_at - body - discussion: &700 + discussion: &701 title: Discussion description: A Discussion in a repository. type: object @@ -123901,10 +124251,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124031,11 +124381,11 @@ webhooks: - from required: - category - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124118,11 +124468,11 @@ webhooks: type: string enum: - closed - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124204,7 +124554,7 @@ webhooks: type: string enum: - created - comment: &701 + comment: &702 type: object properties: author_association: @@ -124364,11 +124714,11 @@ webhooks: - updated_at - body - reactions - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124451,12 +124801,12 @@ webhooks: type: string enum: - deleted - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *702 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124551,12 +124901,12 @@ webhooks: - from required: - body - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *702 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124640,11 +124990,11 @@ webhooks: type: string enum: - created - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124726,11 +125076,11 @@ webhooks: type: string enum: - deleted - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124830,11 +125180,11 @@ webhooks: type: string required: - from - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124916,10 +125266,10 @@ webhooks: type: string enum: - labeled - discussion: *700 - enterprise: *684 - installation: *685 - label: &703 + discussion: *701 + enterprise: *685 + installation: *686 + label: &704 title: Label type: object properties: @@ -124952,8 +125302,8 @@ webhooks: - color - default - description - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125036,11 +125386,11 @@ webhooks: type: string enum: - locked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125122,11 +125472,11 @@ webhooks: type: string enum: - pinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125208,11 +125558,11 @@ webhooks: type: string enum: - reopened - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125297,16 +125647,16 @@ webhooks: changes: type: object properties: - new_discussion: *700 - new_repository: *687 + new_discussion: *701 + new_repository: *688 required: - new_discussion - new_repository - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125389,10 +125739,10 @@ webhooks: type: string enum: - unanswered - discussion: *700 - old_answer: *702 - organization: *686 - repository: *687 + discussion: *701 + old_answer: *703 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125474,12 +125824,12 @@ webhooks: type: string enum: - unlabeled - discussion: *700 - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125562,11 +125912,11 @@ webhooks: type: string enum: - unlocked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125648,11 +125998,11 @@ webhooks: type: string enum: - unpinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125725,7 +126075,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *684 + enterprise: *685 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126403,9 +126753,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - forkee @@ -126551,9 +126901,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pages: description: The pages that were updated. type: array @@ -126591,7 +126941,7 @@ webhooks: - action - sha - html_url - repository: *687 + repository: *688 sender: *4 required: - pages @@ -126667,10 +127017,10 @@ webhooks: type: string enum: - created - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: &705 + organization: *687 + repositories: &706 description: An array of repository objects that the installation can access. type: array @@ -126696,8 +127046,8 @@ webhooks: - name - full_name - private - repository: *687 - requester: *704 + repository: *688 + requester: *705 sender: *4 required: - action @@ -126772,11 +127122,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -126853,11 +127203,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -126934,10 +127284,10 @@ webhooks: type: string enum: - added - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories_added: &706 + organization: *687 + repositories_added: &707 description: An array of repository objects, which were added to the installation. type: array @@ -126983,15 +127333,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *687 - repository_selection: &707 + repository: *688 + repository_selection: &708 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *704 + requester: *705 sender: *4 required: - action @@ -127070,10 +127420,10 @@ webhooks: type: string enum: - removed - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories_added: *706 + organization: *687 + repositories_added: *707 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127100,9 +127450,9 @@ webhooks: - name - full_name - private - repository: *687 - repository_selection: *707 - requester: *704 + repository: *688 + repository_selection: *708 + requester: *705 sender: *4 required: - action @@ -127181,11 +127531,11 @@ webhooks: type: string enum: - suspend - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -127367,10 +127717,10 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 target_type: type: string @@ -127449,11 +127799,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -127701,8 +128051,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128519,8 +128869,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128881,8 +129231,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -128962,7 +129312,7 @@ webhooks: type: string enum: - deleted - comment: &708 + comment: &709 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129129,8 +129479,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129943,8 +130293,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130307,8 +130657,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -130388,7 +130738,7 @@ webhooks: type: string enum: - edited - changes: &732 + changes: &733 description: The changes to the comment. type: object properties: @@ -130400,9 +130750,9 @@ webhooks: type: string required: - from - comment: *708 - enterprise: *684 - installation: *685 + comment: *709 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131218,8 +131568,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131580,8 +131930,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131671,9 +132021,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131767,9 +132117,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131862,9 +132212,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131958,9 +132308,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -132045,10 +132395,10 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - issue: &711 + assignee: *705 + enterprise: *685 + installation: *686 + issue: &712 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132860,11 +133210,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132984,8 +133334,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -133065,8 +133415,8 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133883,11 +134233,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134150,8 +134500,8 @@ webhooks: required: - state - closed_at - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -134230,8 +134580,8 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135039,11 +135389,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135162,8 +135512,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -135242,8 +135592,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136074,11 +136424,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136176,7 +136526,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &709 + milestone: &710 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136319,8 +136669,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -136419,8 +136769,8 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137232,11 +137582,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137356,9 +137706,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -137438,8 +137788,8 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138250,11 +138600,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138374,9 +138724,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -138456,8 +138806,8 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139293,11 +139643,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139394,8 +139744,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -139474,8 +139824,8 @@ webhooks: type: string enum: - milestoned - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140305,11 +140655,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140406,9 +140756,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *709 - organization: *686 - repository: *687 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -141300,11 +141650,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141881,8 +142231,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142694,11 +143044,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142817,8 +143167,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -142898,9 +143248,9 @@ webhooks: type: string enum: - pinned - enterprise: *684 - installation: *685 - issue: &710 + enterprise: *685 + installation: *686 + issue: &711 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143706,11 +144056,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143829,8 +144179,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -143909,8 +144259,8 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144744,11 +145094,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144846,8 +145196,8 @@ webhooks: user_view_type: type: string type: *208 - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -145736,11 +146086,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146339,11 +146689,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *711 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146423,12 +146773,12 @@ webhooks: type: string enum: - typed - enterprise: *684 - installation: *685 - issue: *711 + enterprise: *685 + installation: *686 + issue: *712 type: *208 - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146509,7 +146859,7 @@ webhooks: type: string enum: - unassigned - assignee: &735 + assignee: &736 title: User type: - object @@ -146581,11 +146931,11 @@ webhooks: required: - login - id - enterprise: *684 - installation: *685 - issue: *711 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *712 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146664,12 +147014,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - issue: *711 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *712 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146749,8 +147099,8 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147584,11 +147934,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147685,8 +148035,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -147766,11 +148116,11 @@ webhooks: type: string enum: - unpinned - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *711 + organization: *687 + repository: *688 sender: *4 required: - action @@ -147849,12 +148199,12 @@ webhooks: type: string enum: - untyped - enterprise: *684 - installation: *685 - issue: *711 + enterprise: *685 + installation: *686 + issue: *712 type: *208 - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -147934,11 +148284,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -148016,11 +148366,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -148130,11 +148480,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -148216,9 +148566,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: &712 + enterprise: *685 + installation: *686 + marketplace_purchase: &713 title: Marketplace Purchase type: object required: @@ -148306,8 +148656,8 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: &713 + organization: *687 + previous_marketplace_purchase: &714 title: Marketplace Purchase type: object properties: @@ -148391,7 +148741,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *688 sender: *4 required: - action @@ -148471,10 +148821,10 @@ webhooks: - changed effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *685 + installation: *686 + marketplace_purchase: *713 + organization: *687 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148562,7 +148912,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *688 sender: *4 required: - action @@ -148644,10 +148994,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *685 + installation: *686 + marketplace_purchase: *713 + organization: *687 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148733,7 +149083,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *688 sender: *4 required: - action @@ -148814,8 +149164,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 marketplace_purchase: title: Marketplace Purchase type: object @@ -148901,9 +149251,9 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + organization: *687 + previous_marketplace_purchase: *714 + repository: *688 sender: *4 required: - action @@ -148983,12 +149333,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + enterprise: *685 + installation: *686 + marketplace_purchase: *713 + organization: *687 + previous_marketplace_purchase: *714 + repository: *688 sender: *4 required: - action @@ -149090,11 +149440,11 @@ webhooks: type: string required: - to - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149196,11 +149546,11 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149279,11 +149629,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149361,11 +149711,11 @@ webhooks: type: string enum: - added - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149443,7 +149793,7 @@ webhooks: required: - login - id - team: &714 + team: &715 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149673,11 +150023,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149756,7 +150106,7 @@ webhooks: required: - login - id - team: *714 + team: *715 required: - action - scope @@ -149838,8 +150188,8 @@ webhooks: type: string enum: - checks_requested - installation: *685 - merge_group: &715 + installation: *686 + merge_group: &716 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149865,8 +150215,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149952,10 +150302,10 @@ webhooks: - merged - invalidated - dequeued - installation: *685 - merge_group: *715 - organization: *686 - repository: *687 + installation: *686 + merge_group: *716 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150028,7 +150378,7 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *685 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -150137,12 +150487,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *685 - organization: *686 + installation: *686 + organization: *687 repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -150222,11 +150572,11 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150305,9 +150655,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - milestone: &716 + enterprise: *685 + installation: *686 + milestone: &717 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150449,8 +150799,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150529,11 +150879,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150643,11 +150993,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150727,11 +151077,11 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - milestone: *716 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *717 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150810,11 +151160,11 @@ webhooks: type: string enum: - blocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *705 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150893,11 +151243,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *705 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150976,9 +151326,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - membership: &717 + enterprise: *685 + installation: *686 + membership: &718 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -151088,8 +151438,8 @@ webhooks: - role - organization_url - user - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151167,11 +151517,11 @@ webhooks: type: string enum: - member_added - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + membership: *718 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151250,8 +151600,8 @@ webhooks: type: string enum: - member_invited - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151373,10 +151723,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 - user: *704 + user: *705 required: - action - invitation @@ -151454,11 +151804,11 @@ webhooks: type: string enum: - member_removed - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + membership: *718 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151545,11 +151895,11 @@ webhooks: properties: from: type: string - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + membership: *718 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151625,9 +151975,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 package: description: Information about the package. type: object @@ -152150,7 +152500,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &718 + items: &719 title: Ruby Gems metadata type: object properties: @@ -152247,7 +152597,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -152323,9 +152673,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 package: description: Information about the package. type: object @@ -152687,7 +153037,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *719 source_url: type: string format: uri @@ -152758,7 +153108,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -152939,12 +153289,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *684 + enterprise: *685 id: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - id @@ -153021,7 +153371,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &719 + personal_access_token_request: &720 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -153171,10 +153521,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *684 - organization: *686 + enterprise: *685 + organization: *687 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153251,11 +153601,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *720 + enterprise: *685 + organization: *687 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153331,11 +153681,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *720 + enterprise: *685 + organization: *687 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153410,11 +153760,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *719 - organization: *686 - enterprise: *684 + personal_access_token_request: *720 + organization: *687 + enterprise: *685 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153519,7 +153869,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *720 + last_response: *721 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153551,8 +153901,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 zen: description: Random string of GitHub zen. @@ -153797,10 +154147,10 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: &721 + enterprise: *685 + installation: *686 + organization: *687 + project_card: &722 title: Project Card type: object properties: @@ -153923,7 +154273,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *688 sender: *4 required: - action @@ -154004,11 +154354,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_card: *722 + repository: *688 sender: *4 required: - action @@ -154088,9 +154438,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 project_card: title: Project Card type: object @@ -154220,7 +154570,7 @@ webhooks: repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -154314,11 +154664,11 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_card: *722 + repository: *688 sender: *4 required: - action @@ -154412,9 +154762,9 @@ webhooks: - from required: - column_id - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 project_card: allOf: - title: Project Card @@ -154611,7 +154961,7 @@ webhooks: type: string required: - after_id - repository: *687 + repository: *688 sender: *4 required: - action @@ -154691,10 +155041,10 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - organization: *686 - project: &723 + enterprise: *685 + installation: *686 + organization: *687 + project: &724 title: Project type: object properties: @@ -154821,7 +155171,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *688 sender: *4 required: - action @@ -154901,10 +155251,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_column: &722 + enterprise: *685 + installation: *686 + organization: *687 + project_column: &723 title: Project Column type: object properties: @@ -154944,7 +155294,7 @@ webhooks: - name - created_at - updated_at - repository: *687 + repository: *688 sender: *4 required: - action @@ -155023,14 +155373,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 + enterprise: *685 + installation: *686 + organization: *687 + project_column: *723 repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -155119,11 +155469,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_column: *723 + repository: *688 sender: *4 required: - action @@ -155203,11 +155553,11 @@ webhooks: type: string enum: - moved - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_column: *723 + repository: *688 sender: *4 required: - action @@ -155287,11 +155637,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 + repository: *688 sender: *4 required: - action @@ -155371,14 +155721,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project: *723 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -155479,11 +155829,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 + repository: *688 sender: *4 required: - action @@ -155562,11 +155912,11 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 + repository: *688 sender: *4 required: - action @@ -155647,8 +155997,8 @@ webhooks: type: string enum: - closed - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -155730,8 +156080,8 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -155813,8 +156163,8 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -155936,8 +156286,8 @@ webhooks: type: string to: type: string - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -156021,7 +156371,7 @@ webhooks: type: string enum: - archived - changes: &727 + changes: &728 type: object properties: archived_at: @@ -156037,9 +156387,9 @@ webhooks: - string - 'null' format: date-time - installation: *685 - organization: *686 - projects_v2_item: &724 + installation: *686 + organization: *687 + projects_v2_item: &725 title: Projects v2 Item description: An item belonging to a project type: object @@ -156179,9 +156529,9 @@ webhooks: - 'null' to: type: string - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156263,9 +156613,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156346,9 +156696,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156453,7 +156803,7 @@ webhooks: oneOf: - type: string - type: integer - - &725 + - &726 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156477,7 +156827,7 @@ webhooks: required: - id - name - - &726 + - &727 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156517,8 +156867,8 @@ webhooks: oneOf: - type: string - type: integer - - *725 - *726 + - *727 type: - 'null' - string @@ -156541,9 +156891,9 @@ webhooks: - 'null' required: - body - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156640,9 +156990,9 @@ webhooks: type: - string - 'null' - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156725,10 +157075,10 @@ webhooks: type: string enum: - restored - changes: *727 - installation: *685 - organization: *686 - projects_v2_item: *724 + changes: *728 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156810,8 +157160,8 @@ webhooks: type: string enum: - reopened - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -156893,9 +157243,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *686 + organization: *687 + projects_v2_status_update: *729 sender: *4 required: - action @@ -156976,9 +157326,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *686 + organization: *687 + projects_v2_status_update: *729 sender: *4 required: - action @@ -157124,9 +157474,9 @@ webhooks: - string - 'null' format: date - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *686 + organization: *687 + projects_v2_status_update: *729 sender: *4 required: - action @@ -157197,10 +157547,10 @@ webhooks: title: public event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - repository @@ -157277,13 +157627,13 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - number: &729 + assignee: *705 + enterprise: *685 + installation: *686 + number: &730 description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -159632,7 +159982,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -159714,11 +160064,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -162060,7 +162410,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *688 sender: *4 required: - action @@ -162142,11 +162492,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -164488,7 +164838,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *688 sender: *4 required: - action @@ -164570,11 +164920,11 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: &730 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: &731 allOf: - *547 - type: object @@ -164638,7 +164988,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *687 + repository: *688 sender: *4 required: - action @@ -164719,12 +165069,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -164804,11 +165154,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 + enterprise: *685 milestone: *244 - number: *729 - organization: *686 - pull_request: &731 + number: *730 + organization: *687 + pull_request: &732 title: Pull Request type: object properties: @@ -167135,7 +167485,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -167214,11 +167564,11 @@ webhooks: type: string enum: - dequeued - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -169564,7 +169914,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *687 + repository: *688 sender: *4 required: - action @@ -169688,12 +170038,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -169773,11 +170123,11 @@ webhooks: type: string enum: - enqueued - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -172108,7 +172458,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -172188,11 +172538,11 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + label: *704 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -174540,7 +174890,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -174621,10 +174971,10 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -176970,7 +177320,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -177050,12 +177400,12 @@ webhooks: type: string enum: - milestoned - enterprise: *684 + enterprise: *685 milestone: *244 - number: *729 - organization: *686 - pull_request: *731 - repository: *687 + number: *730 + organization: *687 + pull_request: *732 + repository: *688 sender: *4 required: - action @@ -177134,12 +177484,12 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -177220,12 +177570,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -177305,12 +177655,12 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -177685,9 +178035,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: type: object properties: @@ -179917,7 +180267,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *688 sender: *4 required: - action @@ -179997,7 +180347,7 @@ webhooks: type: string enum: - deleted - comment: &733 + comment: &734 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -180290,9 +180640,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: type: object properties: @@ -182510,7 +182860,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *688 sender: *4 required: - action @@ -182590,11 +182940,11 @@ webhooks: type: string enum: - edited - changes: *732 - comment: *733 - enterprise: *684 - installation: *685 - organization: *686 + changes: *733 + comment: *734 + enterprise: *685 + installation: *686 + organization: *687 pull_request: type: object properties: @@ -184815,7 +185165,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *688 sender: *4 required: - action @@ -184896,9 +185246,9 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -187131,7 +187481,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *688 review: description: The review that was affected. type: object @@ -187382,9 +187732,9 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -189498,8 +189848,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: &734 + repository: *688 + review: &735 description: The review that was affected. type: object properties: @@ -189737,12 +190087,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -192089,7 +192439,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_reviewer: title: User type: @@ -192175,12 +192525,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -194534,7 +194884,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194729,12 +195079,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -197083,7 +197433,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_reviewer: title: User type: @@ -197170,12 +197520,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -199515,7 +199865,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199699,9 +200049,9 @@ webhooks: type: string enum: - submitted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -201937,8 +202287,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: *734 + repository: *688 + review: *735 sender: *4 required: - action @@ -202018,9 +202368,9 @@ webhooks: type: string enum: - resolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -204151,7 +204501,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *688 sender: *4 thread: type: object @@ -204548,9 +204898,9 @@ webhooks: type: string enum: - unresolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -206664,7 +207014,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *688 sender: *4 thread: type: object @@ -207063,10 +207413,10 @@ webhooks: type: string before: type: string - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -209401,7 +209751,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -209483,11 +209833,11 @@ webhooks: type: string enum: - unassigned - assignee: *735 - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + assignee: *736 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -211837,7 +212187,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -211916,11 +212266,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + label: *704 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -214259,7 +214609,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -214340,10 +214690,10 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -216672,7 +217022,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -216875,7 +217225,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *684 + enterprise: *685 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216970,8 +217320,8 @@ webhooks: - url - author - committer - installation: *685 - organization: *686 + installation: *686 + organization: *687 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217559,9 +217909,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 registry_package: type: object properties: @@ -218038,7 +218388,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *718 + items: *719 summary: type: string tag_name: @@ -218094,7 +218444,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -218172,9 +218522,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 registry_package: type: object properties: @@ -218486,7 +218836,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *719 summary: type: string tag_name: @@ -218536,7 +218886,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -218613,10 +218963,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - release: &736 + enterprise: *685 + installation: *686 + organization: *687 + release: &737 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218947,7 +219297,7 @@ webhooks: - updated_at - zipball_url - body - repository: *687 + repository: *688 sender: *4 required: - action @@ -219024,11 +219374,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *737 + repository: *688 sender: *4 required: - action @@ -219145,11 +219495,11 @@ webhooks: type: boolean required: - to - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *737 + repository: *688 sender: *4 required: - action @@ -219227,9 +219577,9 @@ webhooks: type: string enum: - prereleased - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219565,7 +219915,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *688 sender: *4 required: - action @@ -219641,10 +219991,10 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - release: &737 + enterprise: *685 + installation: *686 + organization: *687 + release: &738 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219977,7 +220327,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *688 sender: *4 required: - action @@ -220053,11 +220403,11 @@ webhooks: type: string enum: - released - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *737 + repository: *688 sender: *4 required: - action @@ -220133,11 +220483,11 @@ webhooks: type: string enum: - unpublished - enterprise: *684 - installation: *685 - organization: *686 - release: *737 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *738 + repository: *688 sender: *4 required: - action @@ -220213,11 +220563,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + repository_advisory: *612 sender: *4 required: - action @@ -220293,11 +220643,11 @@ webhooks: type: string enum: - reported - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + repository_advisory: *612 sender: *4 required: - action @@ -220373,10 +220723,10 @@ webhooks: type: string enum: - archived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220453,10 +220803,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220534,10 +220884,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220622,10 +220972,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220740,10 +221090,10 @@ webhooks: - 'null' items: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220815,10 +221165,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 status: type: string @@ -220899,10 +221249,10 @@ webhooks: type: string enum: - privatized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220979,10 +221329,10 @@ webhooks: type: string enum: - publicized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221076,10 +221426,10 @@ webhooks: - name required: - repository - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221159,10 +221509,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 repository_ruleset: *283 sender: *4 required: @@ -221241,10 +221591,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 repository_ruleset: *283 sender: *4 required: @@ -221323,10 +221673,10 @@ webhooks: type: string enum: - edited - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 repository_ruleset: *283 changes: type: object @@ -221634,10 +221984,10 @@ webhooks: - from required: - owner - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221715,10 +222065,10 @@ webhooks: type: string enum: - unarchived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221796,7 +222146,7 @@ webhooks: type: string enum: - create - alert: &738 + alert: &739 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221920,10 +222270,10 @@ webhooks: type: string enum: - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222133,10 +222483,10 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222214,11 +222564,11 @@ webhooks: type: string enum: - reopen - alert: *738 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *739 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222420,10 +222770,10 @@ webhooks: enum: - fixed - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222441,7 +222791,7 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -222449,8 +222799,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -222494,14 +222844,14 @@ webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &739 + - assigned + alert: &740 type: object properties: number: *154 @@ -222615,10 +222965,93 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + assignee: *4 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222699,11 +223132,11 @@ webhooks: type: string enum: - created - alert: *739 - installation: *685 - location: *740 - organization: *686 - repository: *687 + alert: *740 + installation: *686 + location: *741 + organization: *687 + repository: *688 sender: *4 required: - location @@ -222941,11 +223374,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223023,11 +223456,11 @@ webhooks: type: string enum: - reopened - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223105,11 +223538,94 @@ webhooks: type: string enum: - resolved - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *740 + assignee: *4 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223187,11 +223703,11 @@ webhooks: type: string enum: - validated - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223321,10 +223837,10 @@ webhooks: - organization - enterprise - - repository: *687 - enterprise: *684 - installation: *685 - organization: *686 + repository: *688 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -223402,11 +223918,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: &741 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + security_advisory: &742 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223592,11 +224108,11 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: *741 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + security_advisory: *742 sender: *4 required: - action @@ -223669,10 +224185,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223859,9 +224375,9 @@ webhooks: type: object properties: security_and_analysis: *257 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: *317 sender: *4 required: @@ -223940,12 +224456,12 @@ webhooks: type: string enum: - cancelled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: &742 + sponsorship: &743 type: object properties: created_at: @@ -224250,12 +224766,12 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - sponsorship @@ -224343,12 +224859,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - changes @@ -224425,17 +224941,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &743 + effective_date: &744 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - sponsorship @@ -224509,7 +225025,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &744 + changes: &745 type: object properties: tier: @@ -224553,13 +225069,13 @@ webhooks: - from required: - tier - effective_date: *743 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + effective_date: *744 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - changes @@ -224636,13 +225152,13 @@ webhooks: type: string enum: - tier_changed - changes: *744 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + changes: *745 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - changes @@ -224716,10 +225232,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224803,10 +225319,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225240,15 +225756,15 @@ webhooks: type: - string - 'null' - enterprise: *684 + enterprise: *685 id: description: The unique identifier of the status. type: integer - installation: *685 + installation: *686 name: type: string - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 sha: description: The Commit SHA. @@ -225364,9 +225880,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225456,9 +225972,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225548,9 +226064,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225640,9 +226156,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225719,12 +226235,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - team: &745 + team: &746 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225954,9 +226470,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -226426,7 +226942,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -226502,9 +227018,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -226974,7 +227490,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -227051,9 +227567,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -227523,7 +228039,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -227667,9 +228183,9 @@ webhooks: - from required: - permissions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -228139,7 +228655,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - changes @@ -228217,9 +228733,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -228689,7 +229205,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -228765,10 +229281,10 @@ webhooks: type: string enum: - started - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -228841,17 +229357,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *684 + enterprise: *685 inputs: type: - object - 'null' additionalProperties: true - installation: *685 - organization: *686 + installation: *686 + organization: *687 ref: type: string - repository: *687 + repository: *688 sender: *4 workflow: type: string @@ -228933,10 +229449,10 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: allOf: @@ -229271,10 +229787,10 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: allOf: @@ -229635,10 +230151,10 @@ webhooks: type: string enum: - queued - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: type: object @@ -229863,10 +230379,10 @@ webhooks: type: string enum: - waiting - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: type: object @@ -230093,12 +230609,12 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Workflow Run type: object @@ -231117,12 +231633,12 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Workflow Run type: object @@ -232126,12 +232642,12 @@ webhooks: type: string enum: - requested - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index b8794fd6f..2a4582b0f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -5443,6 +5443,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6575,6 +6583,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7480,6 +7496,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7950,6 +7974,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10278,6 +10310,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11442,6 +11482,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12470,6 +12518,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13201,6 +13257,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -62593,7 +62657,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } } } @@ -117213,6 +117292,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -118360,6 +118447,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -160316,21 +160411,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -192534,6 +192647,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -375505,6 +375641,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -551499,6 +551643,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -554285,7 +554452,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -554360,6 +554527,13 @@ "string", "null" ] + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] } }, "anyOf": [ @@ -554367,6 +554541,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -554376,6 +554555,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -555625,7 +555816,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -555639,7 +555850,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -637273,6 +637484,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -696490,6 +696709,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -703951,51 +704178,732 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for user", - "description": "Get a specific field for a user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "name": "project_number", - "description": "The project's number.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.", + "name": "project_number", + "description": "The project's number.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { @@ -704202,21 +705110,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -765962,6 +766888,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -768741,6 +769674,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -897391,6 +898331,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -900498,6 +901446,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -903510,6 +904466,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -906522,6 +907486,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -909668,6 +910640,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -912821,6 +913801,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -917969,6 +918957,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1382840,206 +1383836,4337 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "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": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1384915,7 +1390042,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1384931,23 +1390058,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1385012,15 +1390137,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1386895,6 +1392204,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1386910,21 +1392220,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1386991,13 +1392299,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1389070,11 +1394378,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1389141,13 +1394449,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1389158,9 +1394466,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1389180,12 +1394485,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1389285,9 +1394584,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1389329,7 +1394625,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1391204,285 +1396501,1126 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "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": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": [ - "object", - "null" - ], - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1393359,8 +1399497,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1393374,21 +1399511,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1393453,184 +1399591,856 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "url": { - "type": "string", - "format": "uri" } - } - }, - "external_identifier": { - "type": "string" + ] }, - "external_reference": { + "resolution_comment": { "type": [ "string", "null" ], - "format": "uri" + "description": "An optional comment to resolve an alert." }, - "fix_reason": { - "type": "string" + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." }, - "fixed_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "fixed_in": { - "type": "string" + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "id": { - "type": "integer" + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "node_id": { - "type": "string" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "severity": { - "type": "string" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] } } @@ -1395510,8 +1402320,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1395525,21 +1402334,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1395604,7 +1402414,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1396458,96 +1403268,6 @@ } } }, - "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/admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1396573,6 +1403293,354 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "examples": [ + "commit" + ] + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1398331,10 +1405399,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1398346,8 +1405589,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1398356,13 +1405600,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1398427,13 +1405671,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1399281,378 +1406525,120 @@ } } }, - "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "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/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, "id": { - "description": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", - "node_id" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1401412,185 +1408398,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1401602,9 +1408413,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1401613,11 +1408423,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1401684,13 +1408494,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1404436,11 +1411246,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1404507,13 +1411317,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1407259,11 +1414069,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1407330,13 +1414140,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1408184,6 +1414994,174 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 0fb62e763..608bfc8c8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1073,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &613 + - &614 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -2343,6 +2343,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -11108,7 +11115,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &625 + sub_issues_summary: &626 title: Sub-issues Summary type: object properties: @@ -11129,7 +11136,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &626 + issue_dependencies_summary: &627 title: Issue Dependencies Summary type: object properties: @@ -11148,7 +11155,7 @@ paths: - total_blocking issue_field_values: type: array - items: &627 + items: &628 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11821,7 +11828,7 @@ paths: url: type: string format: uri - user: &639 + user: &640 title: Public User description: Public User type: object @@ -17179,7 +17186,19 @@ paths: update-budget: value: message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *23 '403': *27 @@ -17310,7 +17329,7 @@ paths: required: false schema: type: string - - &677 + - &678 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -17456,7 +17475,7 @@ paths: parameters: - *61 - *99 - - &678 + - &679 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -17568,7 +17587,7 @@ paths: - *99 - *101 - *100 - - &679 + - &680 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -17576,7 +17595,7 @@ paths: schema: type: string - *102 - - &680 + - &681 name: sku description: The SKU to query for usage. in: query @@ -21267,7 +21286,7 @@ paths: type: array items: *136 examples: - default: &642 + default: &643 value: total_count: 1 repositories: @@ -24205,12 +24224,12 @@ paths: required: - subject_digests examples: - default: &669 + default: &670 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &670 + withPredicateType: &671 value: subject_digests: - sha256:abc123 @@ -24269,7 +24288,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &671 + default: &672 value: attestations_subject_digests: - sha256:abc: @@ -33989,7 +34008,7 @@ paths: parameters: - *61 - *220 - - &654 + - &655 name: repo_name description: repo_name parameter in: path @@ -35048,7 +35067,7 @@ paths: - nuget - container - *61 - - &655 + - &656 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35089,7 +35108,7 @@ paths: default: *226 '403': *27 '401': *23 - '400': &657 + '400': &658 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -36915,7 +36934,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &728 + - &729 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -37816,7 +37835,7 @@ paths: - updated_at - project_url examples: - default: &674 + default: &675 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37948,7 +37967,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *243 - - &675 + - &676 name: field_id description: The unique identifier of the field. in: path @@ -37963,7 +37982,7 @@ paths: application/json: schema: *246 examples: - default: &676 + default: &677 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37972,17 +37991,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -42946,6 +42977,25 @@ paths: schema: type: string - &584 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &585 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -42960,7 +43010,7 @@ paths: - *46 - *19 - *17 - - &585 + - &586 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -42970,7 +43020,7 @@ paths: required: false schema: type: string - - &586 + - &587 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -42980,7 +43030,7 @@ paths: required: false schema: type: string - - &587 + - &588 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -42989,7 +43039,7 @@ paths: required: false schema: type: string - - &588 + - &589 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -42998,7 +43048,7 @@ paths: schema: type: boolean default: false - - &589 + - &590 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -43007,7 +43057,7 @@ paths: schema: type: boolean default: false - - &590 + - &591 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -43039,14 +43089,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &591 + state: &592 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &592 + resolution: &593 type: - string - 'null' @@ -43153,14 +43203,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &593 + - &594 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &595 + - &596 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -43217,7 +43267,7 @@ paths: - blob_url - commit_sha - commit_url - - &596 + - &597 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -43278,7 +43328,7 @@ paths: - page_url - commit_sha - commit_url - - &597 + - &598 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -43293,7 +43343,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &598 + - &599 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -43308,7 +43358,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &599 + - &600 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -43323,7 +43373,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &600 + - &601 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -43338,7 +43388,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &601 + - &602 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -43353,7 +43403,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &602 + - &603 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -43368,7 +43418,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &603 + - &604 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -43383,7 +43433,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &604 + - &605 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -43398,7 +43448,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &605 + - &606 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -43413,7 +43463,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &606 + - &607 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -43428,7 +43478,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &607 + - &608 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -43928,7 +43978,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 description: A repository security advisory. type: object properties: @@ -44247,7 +44297,7 @@ paths: - private_fork additionalProperties: false examples: - default: &612 + default: &613 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -46255,7 +46305,7 @@ paths: - updated_at - url examples: - default: &629 + default: &630 value: - author: login: octocat @@ -46503,7 +46553,7 @@ paths: application/json: schema: *298 examples: - default: &630 + default: &631 value: author: login: octocat @@ -46694,7 +46744,7 @@ paths: - updated_at - url examples: - default: &631 + default: &632 value: - author: login: octocat @@ -46920,7 +46970,7 @@ paths: application/json: schema: *301 examples: - default: &632 + default: &633 value: author: login: octocat @@ -47538,7 +47588,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &633 + response-if-user-is-a-team-maintainer: &634 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47603,7 +47653,7 @@ paths: application/json: schema: *308 examples: - response-if-users-membership-with-team-is-now-pending: &634 + response-if-users-membership-with-team-is-now-pending: &635 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47745,7 +47795,7 @@ paths: - updated_at - permissions examples: - default: &635 + default: &636 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47824,7 +47874,7 @@ paths: application/json: schema: *309 examples: - default: &636 + default: &637 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -48035,7 +48085,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &637 + schema: &638 title: Team Repository description: A team's access to a repository. type: object @@ -48764,7 +48814,7 @@ paths: type: array items: *172 examples: - response-if-child-teams-exist: &638 + response-if-child-teams-exist: &639 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -60213,7 +60263,7 @@ paths: check. type: array items: *390 - deployment: &689 + deployment: &690 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -65428,7 +65478,7 @@ paths: type: array items: *431 examples: - default: &645 + default: &646 value: total_count: 2 machines: @@ -68468,7 +68518,7 @@ paths: application/json: schema: type: array - items: &616 + items: &617 title: Status description: The status of a commit. type: object @@ -70067,7 +70117,7 @@ paths: items: type: object properties: - placeholder_id: &608 + placeholder_id: &609 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -75944,7 +75994,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &720 + last_response: &721 title: Hook Response type: object properties: @@ -77012,7 +77062,7 @@ paths: parameters: - *311 - *312 - - &666 + - &667 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77446,7 +77496,7 @@ paths: type: array items: *501 examples: - default: &659 + default: &660 value: - id: 1 repository: @@ -91366,15 +91416,16 @@ paths: - *582 - *583 - *584 + - *585 - *46 - *19 - *17 - - *585 - *586 - *587 - *588 - *589 - *590 + - *591 responses: '200': description: Response @@ -91382,7 +91433,7 @@ paths: application/json: schema: type: array - items: &594 + items: &595 type: object properties: number: *154 @@ -91398,8 +91449,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *591 - resolution: *592 + state: *592 + resolution: *593 resolved_at: type: - string @@ -91493,7 +91544,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *593 + - *594 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91641,13 +91692,13 @@ paths: - *311 - *312 - *410 - - *590 + - *591 responses: '200': description: Response content: application/json: - schema: *594 + schema: *595 examples: default: value: @@ -91689,6 +91740,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -91709,28 +91762,44 @@ paths: schema: type: object properties: - state: *591 - resolution: *592 + state: *592 + resolution: *593 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: + - string + - 'null' anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *594 + schema: *595 examples: default: value: @@ -91775,6 +91844,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -91782,7 +91870,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *97 x-github: enabledForGitHubApps: true @@ -91818,7 +91907,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &740 + items: &741 type: object properties: type: @@ -91845,7 +91934,6 @@ paths: - commit details: oneOf: - - *595 - *596 - *597 - *598 @@ -91858,6 +91946,7 @@ paths: - *605 - *606 - *607 + - *608 examples: default: value: @@ -91952,14 +92041,14 @@ paths: schema: type: object properties: - reason: &609 + reason: &610 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *608 + placeholder_id: *609 required: - reason - placeholder_id @@ -91976,7 +92065,7 @@ paths: schema: type: object properties: - reason: *609 + reason: *610 expire_at: type: - string @@ -92039,7 +92128,7 @@ paths: properties: incremental_scans: type: array - items: &610 + items: &611 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92067,15 +92156,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *610 + items: *611 backfill_scans: type: array - items: *610 + items: *611 custom_pattern_backfill_scans: type: array items: allOf: - - *610 + - *611 - type: object properties: pattern_name: @@ -92190,9 +92279,9 @@ paths: application/json: schema: type: array - items: *611 + items: *612 examples: - default: *612 + default: *613 '400': *14 '404': *6 x-github: @@ -92386,9 +92475,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: &614 + default: &615 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92735,7 +92824,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: default: value: @@ -92884,15 +92973,15 @@ paths: parameters: - *311 - *312 - - *613 + - *614 responses: '200': description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *614 + default: *615 '403': *27 '404': *6 x-github: @@ -92918,7 +93007,7 @@ paths: parameters: - *311 - *312 - - *613 + - *614 requestBody: required: true content: @@ -93089,10 +93178,10 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *614 - add_credit: *614 + default: *615 + add_credit: *615 '403': *27 '404': *6 '422': @@ -93132,7 +93221,7 @@ paths: parameters: - *311 - *312 - - *613 + - *614 responses: '202': *37 '400': *14 @@ -93161,7 +93250,7 @@ paths: parameters: - *311 - *312 - - *613 + - *614 responses: '202': description: Response @@ -93302,7 +93391,7 @@ paths: application/json: schema: type: array - items: &615 + items: &616 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93675,7 +93764,7 @@ paths: application/json: schema: type: array - items: *615 + items: *616 examples: default: value: @@ -93765,7 +93854,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -93859,7 +93948,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &617 + schema: &618 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93959,7 +94048,7 @@ paths: description: Response content: application/json: - schema: *617 + schema: *618 examples: default: value: @@ -94099,7 +94188,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Tag protection description: Tag protection type: object @@ -94180,7 +94269,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -94328,7 +94417,7 @@ paths: description: Response content: application/json: - schema: &619 + schema: &620 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94340,7 +94429,7 @@ paths: required: - names examples: - default: &620 + default: &621 value: names: - octocat @@ -94395,9 +94484,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *620 + default: *621 '404': *6 '422': *7 x-github: @@ -94420,7 +94509,7 @@ paths: parameters: - *311 - *312 - - &621 + - &622 name: per description: The time frame to display results for. in: query @@ -94451,7 +94540,7 @@ paths: - 128 clones: type: array - items: &622 + items: &623 title: Traffic type: object properties: @@ -94699,7 +94788,7 @@ paths: parameters: - *311 - *312 - - *621 + - *622 responses: '200': description: Response @@ -94720,7 +94809,7 @@ paths: - 3782 views: type: array - items: *622 + items: *623 required: - uniques - count @@ -95490,7 +95579,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &623 + text_matches: &624 title: Search Result Text Matches type: array items: @@ -95653,7 +95742,7 @@ paths: enum: - author-date - committer-date - - &624 + - &625 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -95773,7 +95862,7 @@ paths: type: number node_id: type: string - text_matches: *623 + text_matches: *624 required: - sha - node_id @@ -95965,7 +96054,7 @@ paths: - interactions - created - updated - - *624 + - *625 - *17 - *19 - name: advanced_search @@ -96062,11 +96151,11 @@ paths: type: - string - 'null' - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: type: string state_reason: @@ -96094,7 +96183,7 @@ paths: - string - 'null' format: date-time - text_matches: *623 + text_matches: *624 pull_request: type: object properties: @@ -96317,7 +96406,7 @@ paths: enum: - created - updated - - *624 + - *625 - *17 - *19 responses: @@ -96362,7 +96451,7 @@ paths: - 'null' score: type: number - text_matches: *623 + text_matches: *624 required: - id - node_id @@ -96447,7 +96536,7 @@ paths: - forks - help-wanted-issues - updated - - *624 + - *625 - *17 - *19 responses: @@ -96684,7 +96773,7 @@ paths: - admin - pull - push - text_matches: *623 + text_matches: *624 temp_clone_token: type: string allow_merge_commit: @@ -96992,7 +97081,7 @@ paths: - string - 'null' format: uri - text_matches: *623 + text_matches: *624 related: type: - array @@ -97185,7 +97274,7 @@ paths: - followers - repositories - joined - - *624 + - *625 - *17 - *19 responses: @@ -97295,7 +97384,7 @@ paths: type: - boolean - 'null' - text_matches: *623 + text_matches: *624 blog: type: - string @@ -97377,7 +97466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &628 + - &629 name: team_id description: The unique identifier of the team. in: path @@ -97418,7 +97507,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *628 + - *629 requestBody: required: true content: @@ -97519,7 +97608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *628 + - *629 responses: '204': description: Response @@ -97550,7 +97639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *628 + - *629 - *46 - *17 - *19 @@ -97563,7 +97652,7 @@ paths: type: array items: *298 examples: - default: *629 + default: *630 headers: Link: *52 x-github: @@ -97592,7 +97681,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *628 + - *629 requestBody: required: true content: @@ -97655,7 +97744,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *628 + - *629 - *300 responses: '200': @@ -97689,7 +97778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *628 + - *629 - *300 requestBody: required: false @@ -97715,7 +97804,7 @@ paths: application/json: schema: *298 examples: - default: *630 + default: *631 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97740,7 +97829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *628 + - *629 - *300 responses: '204': @@ -97770,7 +97859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *628 + - *629 - *300 - *46 - *17 @@ -97784,7 +97873,7 @@ paths: type: array items: *301 examples: - default: *631 + default: *632 headers: Link: *52 x-github: @@ -97813,7 +97902,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 requestBody: required: true @@ -97865,7 +97954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 responses: @@ -97900,7 +97989,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 requestBody: @@ -97926,7 +98015,7 @@ paths: application/json: schema: *301 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97951,7 +98040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 responses: @@ -97982,7 +98071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 - name: content @@ -98041,7 +98130,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *628 + - *629 - *300 - *303 requestBody: @@ -98103,7 +98192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *628 + - *629 - *300 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -98161,7 +98250,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *628 + - *629 - *300 requestBody: required: true @@ -98220,7 +98309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -98258,7 +98347,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *628 + - *629 - name: role description: Filters members returned by their role in the team. in: query @@ -98309,7 +98398,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98346,7 +98435,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98386,7 +98475,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98423,7 +98512,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *628 + - *629 - *57 responses: '200': @@ -98432,7 +98521,7 @@ paths: application/json: schema: *308 examples: - response-if-user-is-a-team-maintainer: *633 + response-if-user-is-a-team-maintainer: *634 '404': *6 x-github: githubCloudOnly: false @@ -98465,7 +98554,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *628 + - *629 - *57 requestBody: required: false @@ -98493,7 +98582,7 @@ paths: application/json: schema: *308 examples: - response-if-users-membership-with-team-is-now-pending: *634 + response-if-users-membership-with-team-is-now-pending: *635 '403': description: Forbidden if team synchronization is set up '422': @@ -98527,7 +98616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *628 + - *629 - *57 responses: '204': @@ -98556,7 +98645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -98568,7 +98657,7 @@ paths: type: array items: *309 examples: - default: *635 + default: *636 headers: Link: *52 '404': *6 @@ -98594,7 +98683,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *628 + - *629 - *310 responses: '200': @@ -98603,7 +98692,7 @@ paths: application/json: schema: *309 examples: - default: *636 + default: *637 '404': description: Not Found if project is not managed by this team x-github: @@ -98627,7 +98716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *628 + - *629 - *310 requestBody: required: false @@ -98695,7 +98784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *628 + - *629 - *310 responses: '204': @@ -98723,7 +98812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -98765,7 +98854,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *628 + - *629 - *311 - *312 responses: @@ -98773,7 +98862,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *637 + schema: *638 examples: alternative-response-with-extra-repository-information: value: @@ -98924,7 +99013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *628 + - *629 - *311 - *312 requestBody: @@ -98976,7 +99065,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *628 + - *629 - *311 - *312 responses: @@ -99003,7 +99092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *628 + - *629 - *17 - *19 responses: @@ -99015,7 +99104,7 @@ paths: type: array items: *172 examples: - response-if-child-teams-exist: *638 + response-if-child-teams-exist: *639 headers: Link: *52 '404': *6 @@ -99048,7 +99137,7 @@ paths: application/json: schema: oneOf: - - &640 + - &641 title: Private User description: Private User type: object @@ -99298,7 +99387,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *639 + - *640 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99458,7 +99547,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -99856,7 +99945,7 @@ paths: type: integer secrets: type: array - items: &641 + items: &642 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99976,7 +100065,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -100122,7 +100211,7 @@ paths: type: array items: *136 examples: - default: *642 + default: *643 '401': *23 '403': *27 '404': *6 @@ -100389,7 +100478,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100442,7 +100531,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &644 + default: &645 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100487,9 +100576,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -100528,7 +100617,7 @@ paths: type: array items: *431 examples: - default: *645 + default: *646 '304': *35 '500': *96 '401': *23 @@ -101494,7 +101583,7 @@ paths: type: array items: *225 examples: - default: &656 + default: &657 value: - id: 197 name: hello_docker @@ -101595,7 +101684,7 @@ paths: application/json: schema: type: array - items: &646 + items: &647 title: Email description: Email type: object @@ -101665,9 +101754,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: &658 + default: &659 value: - email: octocat@github.com verified: true @@ -101744,7 +101833,7 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: default: value: @@ -102002,7 +102091,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: GPG Key description: A unique encryption key type: object @@ -102147,7 +102236,7 @@ paths: - subkeys - revoked examples: - default: &672 + default: &673 value: - id: 3 name: Octocat's GPG Key @@ -102232,9 +102321,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: &648 + default: &649 value: id: 3 name: Octocat's GPG Key @@ -102291,7 +102380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &649 + - &650 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102303,9 +102392,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: *648 + default: *649 '404': *6 '304': *35 '403': *27 @@ -102328,7 +102417,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *649 + - *650 responses: '204': description: Response @@ -102783,7 +102872,7 @@ paths: application/json: schema: type: array - items: &650 + items: &651 title: Key description: Key type: object @@ -102886,9 +102975,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: &651 + default: &652 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102927,9 +103016,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *651 examples: - default: *651 + default: *652 '404': *6 '304': *35 '403': *27 @@ -102985,7 +103074,7 @@ paths: application/json: schema: type: array - items: &652 + items: &653 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103064,7 +103153,7 @@ paths: - account - plan examples: - default: &653 + default: &654 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103126,9 +103215,9 @@ paths: application/json: schema: type: array - items: *652 + items: *653 examples: - default: *653 + default: *654 headers: Link: *52 '304': *35 @@ -104132,7 +104221,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *220 - - *654 + - *655 responses: '204': description: Response @@ -104247,7 +104336,7 @@ paths: - docker - nuget - container - - *655 + - *656 - *19 - *17 responses: @@ -104259,8 +104348,8 @@ paths: type: array items: *225 examples: - default: *656 - '400': *657 + default: *657 + '400': *658 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104289,7 +104378,7 @@ paths: application/json: schema: *225 examples: - default: &673 + default: &674 value: id: 40201 name: octo-name @@ -104651,9 +104740,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: *658 + default: *659 headers: Link: *52 '304': *35 @@ -104766,7 +104855,7 @@ paths: type: array items: *64 examples: - default: &665 + default: &666 summary: Default response value: - id: 1296269 @@ -105126,7 +105215,7 @@ paths: type: array items: *501 examples: - default: *659 + default: *660 headers: Link: *52 '304': *35 @@ -105205,7 +105294,7 @@ paths: application/json: schema: type: array - items: &660 + items: &661 title: Social account description: Social media account type: object @@ -105222,7 +105311,7 @@ paths: - provider - url examples: - default: &661 + default: &662 value: - provider: twitter url: https://twitter.com/github @@ -105285,9 +105374,9 @@ paths: application/json: schema: type: array - items: *660 + items: *661 examples: - default: *661 + default: *662 '422': *15 '304': *35 '404': *6 @@ -105375,7 +105464,7 @@ paths: application/json: schema: type: array - items: &662 + items: &663 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105395,7 +105484,7 @@ paths: - title - created_at examples: - default: &681 + default: &682 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105460,9 +105549,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: &663 + default: &664 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105492,7 +105581,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &664 + - &665 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105504,9 +105593,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *663 examples: - default: *663 + default: *664 '404': *6 '304': *35 '403': *27 @@ -105529,7 +105618,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *664 + - *665 responses: '204': description: Response @@ -105558,7 +105647,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &682 + - &683 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -105583,11 +105672,11 @@ paths: type: array items: *64 examples: - default-response: *665 + default-response: *666 application/vnd.github.v3.star+json: schema: type: array - items: &683 + items: &684 title: Starred Repository description: Starred Repository type: object @@ -105956,10 +106045,10 @@ paths: application/json: schema: oneOf: + - *641 - *640 - - *639 examples: - default-response: &667 + default-response: &668 summary: Default response value: login: octocat @@ -105994,7 +106083,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &668 + response-with-git-hub-plan-information: &669 summary: Response with GitHub plan information value: login: octocat @@ -106116,7 +106205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *666 + - *667 - *17 responses: '200': @@ -106165,11 +106254,11 @@ paths: application/json: schema: oneOf: + - *641 - *640 - - *639 examples: - default-response: *667 - response-with-git-hub-plan-information: *668 + default-response: *668 + response-with-git-hub-plan-information: *669 '404': *6 x-github: githubCloudOnly: false @@ -106219,8 +106308,8 @@ paths: required: - subject_digests examples: - default: *669 - withPredicateType: *670 + default: *670 + withPredicateType: *671 responses: '200': description: Response @@ -106274,7 +106363,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *671 + default: *672 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106520,7 +106609,7 @@ paths: type: array items: *225 examples: - default: *656 + default: *657 '403': *27 '401': *23 x-github: @@ -106904,9 +106993,9 @@ paths: application/json: schema: type: array - items: *647 + items: *648 examples: - default: *672 + default: *673 headers: Link: *52 x-github: @@ -107135,7 +107224,7 @@ paths: - docker - nuget - container - - *655 + - *656 - *57 - *19 - *17 @@ -107148,10 +107237,10 @@ paths: type: array items: *225 examples: - default: *656 + default: *657 '403': *27 '401': *23 - '400': *657 + '400': *658 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107181,7 +107270,7 @@ paths: application/json: schema: *225 examples: - default: *673 + default: *674 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107530,7 +107619,7 @@ paths: type: array items: *246 examples: - default: *674 + default: *675 headers: Link: *52 '304': *35 @@ -107541,6 +107630,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - *57 + - *243 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *246 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *35 + '403': *27 + '401': *23 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -107553,7 +107893,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *243 - - *675 + - *676 - *57 responses: '200': @@ -107562,7 +107902,7 @@ paths: application/json: schema: *246 examples: - default: *676 + default: *677 headers: Link: *52 '304': *35 @@ -108096,7 +108436,7 @@ paths: - *99 - *101 - *100 - - *677 + - *678 - *102 responses: '200': @@ -108227,7 +108567,7 @@ paths: parameters: - *57 - *99 - - *678 + - *679 - *100 responses: '200': @@ -108326,9 +108666,9 @@ paths: - *99 - *101 - *100 - - *679 - - *102 - *680 + - *102 + - *681 responses: '200': description: Response when getting a billing usage summary @@ -108462,9 +108802,9 @@ paths: application/json: schema: type: array - items: *660 + items: *661 examples: - default: *661 + default: *662 headers: Link: *52 x-github: @@ -108494,9 +108834,9 @@ paths: application/json: schema: type: array - items: *662 + items: *663 examples: - default: *681 + default: *682 headers: Link: *52 x-github: @@ -108521,7 +108861,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *57 - - *682 + - *683 - *46 - *17 - *19 @@ -108533,11 +108873,11 @@ paths: schema: anyOf: - type: array - items: *683 + items: *684 - type: array items: *64 examples: - default-response: *665 + default-response: *666 headers: Link: *52 x-github: @@ -108697,7 +109037,7 @@ webhooks: type: string enum: - disabled - enterprise: &684 + enterprise: &685 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108766,7 +109106,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &685 + installation: &686 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108787,7 +109127,7 @@ webhooks: required: - id - node_id - organization: &686 + organization: &687 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108860,7 +109200,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &687 + repository: &688 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -109773,10 +110113,10 @@ webhooks: type: string enum: - enabled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -109852,11 +110192,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: &688 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + rule: &689 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -110079,11 +110419,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + rule: *689 sender: *4 required: - action @@ -110271,11 +110611,11 @@ webhooks: - everyone required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + rule: *689 sender: *4 required: - action @@ -110359,7 +110699,7 @@ webhooks: type: string enum: - completed - check_run: &690 + check_run: &691 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110469,7 +110809,7 @@ webhooks: - examples: - neutral - deployment: *689 + deployment: *690 details_url: type: string examples: @@ -110567,10 +110907,10 @@ webhooks: - output - app - pull_requests - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 sender: *4 required: - check_run @@ -110963,11 +111303,11 @@ webhooks: type: string enum: - created - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *691 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 sender: *4 required: - check_run @@ -111363,11 +111703,11 @@ webhooks: type: string enum: - requested_action - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *691 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 requested_action: description: The action requested by the user. type: object @@ -111772,11 +112112,11 @@ webhooks: type: string enum: - rerequested - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *691 + installation: *686 + enterprise: *685 + organization: *687 + repository: *688 sender: *4 required: - check_run @@ -112768,10 +113108,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -113052,6 +113392,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113471,10 +113816,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -113750,6 +114095,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -114168,10 +114518,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -114492,20 +114842,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &691 + commit_oid: &692 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *684 - installation: *685 - organization: *686 - ref: &692 + enterprise: *685 + installation: *686 + organization: *687 + ref: &693 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *687 + repository: *688 sender: *4 required: - action @@ -114913,12 +115263,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -115201,12 +115551,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -115552,12 +115902,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -115840,9 +116190,9 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115850,7 +116200,7 @@ webhooks: type: - string - 'null' - repository: *687 + repository: *688 sender: *4 required: - action @@ -116096,12 +116446,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *692 + enterprise: *685 + installation: *686 + organization: *687 + ref: *693 + repository: *688 sender: *4 required: - action @@ -116363,10 +116713,10 @@ webhooks: - updated_at - author_association - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -116447,18 +116797,18 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *686 - pusher_type: &693 + organization: *687 + pusher_type: &694 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &694 + ref: &695 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116468,7 +116818,7 @@ webhooks: enum: - tag - branch - repository: *687 + repository: *688 sender: *4 required: - ref @@ -116551,9 +116901,9 @@ webhooks: enum: - created definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116638,9 +116988,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116718,9 +117068,9 @@ webhooks: enum: - promote_to_enterprise definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116798,9 +117148,9 @@ webhooks: enum: - updated definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -116877,10 +117227,10 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - repository: *687 - organization: *686 + enterprise: *685 + installation: *686 + repository: *688 + organization: *687 sender: *4 new_property_values: type: array @@ -116965,18 +117315,18 @@ webhooks: title: delete event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - pusher_type: *693 - ref: *694 + enterprise: *685 + installation: *686 + organization: *687 + pusher_type: *694 + ref: *695 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *687 + repository: *688 sender: *4 required: - ref @@ -117061,10 +117411,10 @@ webhooks: enum: - auto_dismissed alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117149,10 +117499,10 @@ webhooks: enum: - auto_reopened alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117237,10 +117587,10 @@ webhooks: enum: - created alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117323,10 +117673,10 @@ webhooks: enum: - dismissed alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117409,10 +117759,10 @@ webhooks: enum: - fixed alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117496,10 +117846,10 @@ webhooks: enum: - reintroduced alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117582,10 +117932,10 @@ webhooks: enum: - reopened alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + installation: *686 + organization: *687 + enterprise: *685 + repository: *688 sender: *4 required: - action @@ -117662,9 +118012,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - key: &695 + enterprise: *685 + installation: *686 + key: &696 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117702,8 +118052,8 @@ webhooks: - verified - created_at - read_only - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -117780,11 +118130,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - key: *695 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + key: *696 + organization: *687 + repository: *688 sender: *4 required: - action @@ -118356,12 +118706,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: &699 + workflow: &700 title: Workflow type: - object @@ -119103,9 +119453,9 @@ webhooks: pull_requests: type: array items: *547 - repository: *687 - organization: *686 - installation: *685 + repository: *688 + organization: *687 + installation: *686 sender: *4 responses: '200': @@ -119176,7 +119526,7 @@ webhooks: type: string enum: - approved - approver: &696 + approver: &697 type: object properties: avatar_url: @@ -119219,11 +119569,11 @@ webhooks: type: string comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: &697 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + reviewers: &698 type: array items: type: object @@ -119304,7 +119654,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &698 + workflow_job_run: &699 type: object properties: conclusion: @@ -120050,18 +120400,18 @@ webhooks: type: string enum: - rejected - approver: *696 + approver: *697 comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: *697 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + reviewers: *698 sender: *4 since: type: string - workflow_job_run: *698 + workflow_job_run: *699 workflow_job_runs: type: array items: @@ -120778,13 +121128,13 @@ webhooks: type: string enum: - requested - enterprise: *684 + enterprise: *685 environment: type: string - installation: *685 - organization: *686 - repository: *687 - requestor: &704 + installation: *686 + organization: *687 + repository: *688 + requestor: &705 title: User type: - object @@ -122727,12 +123077,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Deployment Workflow Run type: @@ -123423,7 +123773,7 @@ webhooks: type: string enum: - answered - answer: &702 + answer: &703 type: object properties: author_association: @@ -123583,7 +123933,7 @@ webhooks: - created_at - updated_at - body - discussion: &700 + discussion: &701 title: Discussion description: A Discussion in a repository. type: object @@ -123901,10 +124251,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124031,11 +124381,11 @@ webhooks: - from required: - category - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124118,11 +124468,11 @@ webhooks: type: string enum: - closed - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124204,7 +124554,7 @@ webhooks: type: string enum: - created - comment: &701 + comment: &702 type: object properties: author_association: @@ -124364,11 +124714,11 @@ webhooks: - updated_at - body - reactions - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124451,12 +124801,12 @@ webhooks: type: string enum: - deleted - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *702 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124551,12 +124901,12 @@ webhooks: - from required: - body - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *702 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124640,11 +124990,11 @@ webhooks: type: string enum: - created - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124726,11 +125076,11 @@ webhooks: type: string enum: - deleted - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124830,11 +125180,11 @@ webhooks: type: string required: - from - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -124916,10 +125266,10 @@ webhooks: type: string enum: - labeled - discussion: *700 - enterprise: *684 - installation: *685 - label: &703 + discussion: *701 + enterprise: *685 + installation: *686 + label: &704 title: Label type: object properties: @@ -124952,8 +125302,8 @@ webhooks: - color - default - description - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125036,11 +125386,11 @@ webhooks: type: string enum: - locked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125122,11 +125472,11 @@ webhooks: type: string enum: - pinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125208,11 +125558,11 @@ webhooks: type: string enum: - reopened - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125297,16 +125647,16 @@ webhooks: changes: type: object properties: - new_discussion: *700 - new_repository: *687 + new_discussion: *701 + new_repository: *688 required: - new_discussion - new_repository - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125389,10 +125739,10 @@ webhooks: type: string enum: - unanswered - discussion: *700 - old_answer: *702 - organization: *686 - repository: *687 + discussion: *701 + old_answer: *703 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125474,12 +125824,12 @@ webhooks: type: string enum: - unlabeled - discussion: *700 - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125562,11 +125912,11 @@ webhooks: type: string enum: - unlocked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125648,11 +125998,11 @@ webhooks: type: string enum: - unpinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *701 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -125725,7 +126075,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *684 + enterprise: *685 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126403,9 +126753,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - forkee @@ -126551,9 +126901,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pages: description: The pages that were updated. type: array @@ -126591,7 +126941,7 @@ webhooks: - action - sha - html_url - repository: *687 + repository: *688 sender: *4 required: - pages @@ -126667,10 +127017,10 @@ webhooks: type: string enum: - created - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: &705 + organization: *687 + repositories: &706 description: An array of repository objects that the installation can access. type: array @@ -126696,8 +127046,8 @@ webhooks: - name - full_name - private - repository: *687 - requester: *704 + repository: *688 + requester: *705 sender: *4 required: - action @@ -126772,11 +127122,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -126853,11 +127203,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -126934,10 +127284,10 @@ webhooks: type: string enum: - added - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories_added: &706 + organization: *687 + repositories_added: &707 description: An array of repository objects, which were added to the installation. type: array @@ -126983,15 +127333,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *687 - repository_selection: &707 + repository: *688 + repository_selection: &708 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *704 + requester: *705 sender: *4 required: - action @@ -127070,10 +127420,10 @@ webhooks: type: string enum: - removed - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories_added: *706 + organization: *687 + repositories_added: *707 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127100,9 +127450,9 @@ webhooks: - name - full_name - private - repository: *687 - repository_selection: *707 - requester: *704 + repository: *688 + repository_selection: *708 + requester: *705 sender: *4 required: - action @@ -127181,11 +127531,11 @@ webhooks: type: string enum: - suspend - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -127367,10 +127717,10 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 target_type: type: string @@ -127449,11 +127799,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *684 + enterprise: *685 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *687 + repositories: *706 + repository: *688 requester: type: - 'null' @@ -127701,8 +128051,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128519,8 +128869,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128881,8 +129231,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -128962,7 +129312,7 @@ webhooks: type: string enum: - deleted - comment: &708 + comment: &709 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129129,8 +129479,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129943,8 +130293,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130307,8 +130657,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -130388,7 +130738,7 @@ webhooks: type: string enum: - edited - changes: &732 + changes: &733 description: The changes to the comment. type: object properties: @@ -130400,9 +130750,9 @@ webhooks: type: string required: - from - comment: *708 - enterprise: *684 - installation: *685 + comment: *709 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131218,8 +131568,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131580,8 +131930,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131671,9 +132021,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131767,9 +132117,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131862,9 +132212,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -131958,9 +132308,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -132045,10 +132395,10 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - issue: &711 + assignee: *705 + enterprise: *685 + installation: *686 + issue: &712 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132860,11 +133210,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132984,8 +133334,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -133065,8 +133415,8 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133883,11 +134233,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134150,8 +134500,8 @@ webhooks: required: - state - closed_at - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -134230,8 +134580,8 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135039,11 +135389,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135162,8 +135512,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -135242,8 +135592,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136074,11 +136424,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136176,7 +136526,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &709 + milestone: &710 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136319,8 +136669,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -136419,8 +136769,8 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137232,11 +137582,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137356,9 +137706,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -137438,8 +137788,8 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138250,11 +138600,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138374,9 +138724,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -138456,8 +138806,8 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139293,11 +139643,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139394,8 +139744,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -139474,8 +139824,8 @@ webhooks: type: string enum: - milestoned - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140305,11 +140655,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140406,9 +140756,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *709 - organization: *686 - repository: *687 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -141300,11 +141650,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141881,8 +142231,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142694,11 +143044,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142817,8 +143167,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -142898,9 +143248,9 @@ webhooks: type: string enum: - pinned - enterprise: *684 - installation: *685 - issue: &710 + enterprise: *685 + installation: *686 + issue: &711 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143706,11 +144056,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143829,8 +144179,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -143909,8 +144259,8 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144744,11 +145094,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144846,8 +145196,8 @@ webhooks: user_view_type: type: string type: *208 - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -145736,11 +146086,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146339,11 +146689,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *711 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146423,12 +146773,12 @@ webhooks: type: string enum: - typed - enterprise: *684 - installation: *685 - issue: *711 + enterprise: *685 + installation: *686 + issue: *712 type: *208 - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146509,7 +146859,7 @@ webhooks: type: string enum: - unassigned - assignee: &735 + assignee: &736 title: User type: - object @@ -146581,11 +146931,11 @@ webhooks: required: - login - id - enterprise: *684 - installation: *685 - issue: *711 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *712 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146664,12 +147014,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - issue: *711 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *712 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -146749,8 +147099,8 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147584,11 +147934,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *626 + issue_dependencies_summary: *627 issue_field_values: type: array - items: *627 + items: *628 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147685,8 +148035,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -147766,11 +148116,11 @@ webhooks: type: string enum: - unpinned - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + issue: *711 + organization: *687 + repository: *688 sender: *4 required: - action @@ -147849,12 +148199,12 @@ webhooks: type: string enum: - untyped - enterprise: *684 - installation: *685 - issue: *711 + enterprise: *685 + installation: *686 + issue: *712 type: *208 - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -147934,11 +148284,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -148016,11 +148366,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -148130,11 +148480,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + label: *704 + organization: *687 + repository: *688 sender: *4 required: - action @@ -148216,9 +148566,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: &712 + enterprise: *685 + installation: *686 + marketplace_purchase: &713 title: Marketplace Purchase type: object required: @@ -148306,8 +148656,8 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: &713 + organization: *687 + previous_marketplace_purchase: &714 title: Marketplace Purchase type: object properties: @@ -148391,7 +148741,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *688 sender: *4 required: - action @@ -148471,10 +148821,10 @@ webhooks: - changed effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *685 + installation: *686 + marketplace_purchase: *713 + organization: *687 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148562,7 +148912,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *688 sender: *4 required: - action @@ -148644,10 +148994,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *685 + installation: *686 + marketplace_purchase: *713 + organization: *687 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148733,7 +149083,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *688 sender: *4 required: - action @@ -148814,8 +149164,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 marketplace_purchase: title: Marketplace Purchase type: object @@ -148901,9 +149251,9 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + organization: *687 + previous_marketplace_purchase: *714 + repository: *688 sender: *4 required: - action @@ -148983,12 +149333,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + enterprise: *685 + installation: *686 + marketplace_purchase: *713 + organization: *687 + previous_marketplace_purchase: *714 + repository: *688 sender: *4 required: - action @@ -149090,11 +149440,11 @@ webhooks: type: string required: - to - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149196,11 +149546,11 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149279,11 +149629,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149361,11 +149711,11 @@ webhooks: type: string enum: - added - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149443,7 +149793,7 @@ webhooks: required: - login - id - team: &714 + team: &715 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149673,11 +150023,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + member: *705 + organization: *687 + repository: *688 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149756,7 +150106,7 @@ webhooks: required: - login - id - team: *714 + team: *715 required: - action - scope @@ -149838,8 +150188,8 @@ webhooks: type: string enum: - checks_requested - installation: *685 - merge_group: &715 + installation: *686 + merge_group: &716 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149865,8 +150215,8 @@ webhooks: - base_sha - base_ref - head_commit - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -149952,10 +150302,10 @@ webhooks: - merged - invalidated - dequeued - installation: *685 - merge_group: *715 - organization: *686 - repository: *687 + installation: *686 + merge_group: *716 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150028,7 +150378,7 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *685 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -150137,12 +150487,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *685 - organization: *686 + installation: *686 + organization: *687 repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -150222,11 +150572,11 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150305,9 +150655,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - milestone: &716 + enterprise: *685 + installation: *686 + milestone: &717 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150449,8 +150799,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150529,11 +150879,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150643,11 +150993,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *710 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150727,11 +151077,11 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - milestone: *716 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + milestone: *717 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150810,11 +151160,11 @@ webhooks: type: string enum: - blocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *705 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150893,11 +151243,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *705 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -150976,9 +151326,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - membership: &717 + enterprise: *685 + installation: *686 + membership: &718 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -151088,8 +151438,8 @@ webhooks: - role - organization_url - user - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151167,11 +151517,11 @@ webhooks: type: string enum: - member_added - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + membership: *718 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151250,8 +151600,8 @@ webhooks: type: string enum: - member_invited - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151373,10 +151723,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 - user: *704 + user: *705 required: - action - invitation @@ -151454,11 +151804,11 @@ webhooks: type: string enum: - member_removed - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + membership: *718 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151545,11 +151895,11 @@ webhooks: properties: from: type: string - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + membership: *718 + organization: *687 + repository: *688 sender: *4 required: - action @@ -151625,9 +151975,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 package: description: Information about the package. type: object @@ -152150,7 +152500,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &718 + items: &719 title: Ruby Gems metadata type: object properties: @@ -152247,7 +152597,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -152323,9 +152673,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 package: description: Information about the package. type: object @@ -152687,7 +153037,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *719 source_url: type: string format: uri @@ -152758,7 +153108,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -152939,12 +153289,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *684 + enterprise: *685 id: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - id @@ -153021,7 +153371,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &719 + personal_access_token_request: &720 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -153171,10 +153521,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *684 - organization: *686 + enterprise: *685 + organization: *687 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153251,11 +153601,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *720 + enterprise: *685 + organization: *687 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153331,11 +153681,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *720 + enterprise: *685 + organization: *687 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153410,11 +153760,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *719 - organization: *686 - enterprise: *684 + personal_access_token_request: *720 + organization: *687 + enterprise: *685 sender: *4 - installation: *685 + installation: *686 required: - action - personal_access_token_request @@ -153519,7 +153869,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *720 + last_response: *721 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153551,8 +153901,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 zen: description: Random string of GitHub zen. @@ -153797,10 +154147,10 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: &721 + enterprise: *685 + installation: *686 + organization: *687 + project_card: &722 title: Project Card type: object properties: @@ -153923,7 +154273,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *688 sender: *4 required: - action @@ -154004,11 +154354,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_card: *722 + repository: *688 sender: *4 required: - action @@ -154088,9 +154438,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 project_card: title: Project Card type: object @@ -154220,7 +154570,7 @@ webhooks: repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -154314,11 +154664,11 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_card: *722 + repository: *688 sender: *4 required: - action @@ -154412,9 +154762,9 @@ webhooks: - from required: - column_id - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 project_card: allOf: - title: Project Card @@ -154611,7 +154961,7 @@ webhooks: type: string required: - after_id - repository: *687 + repository: *688 sender: *4 required: - action @@ -154691,10 +155041,10 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - organization: *686 - project: &723 + enterprise: *685 + installation: *686 + organization: *687 + project: &724 title: Project type: object properties: @@ -154821,7 +155171,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *688 sender: *4 required: - action @@ -154901,10 +155251,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_column: &722 + enterprise: *685 + installation: *686 + organization: *687 + project_column: &723 title: Project Column type: object properties: @@ -154944,7 +155294,7 @@ webhooks: - name - created_at - updated_at - repository: *687 + repository: *688 sender: *4 required: - action @@ -155023,14 +155373,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 + enterprise: *685 + installation: *686 + organization: *687 + project_column: *723 repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -155119,11 +155469,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_column: *723 + repository: *688 sender: *4 required: - action @@ -155203,11 +155553,11 @@ webhooks: type: string enum: - moved - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project_column: *723 + repository: *688 sender: *4 required: - action @@ -155287,11 +155637,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 + repository: *688 sender: *4 required: - action @@ -155371,14 +155721,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project: *723 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 repository: anyOf: - type: 'null' - - *687 + - *688 sender: *4 required: - action @@ -155479,11 +155829,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 + repository: *688 sender: *4 required: - action @@ -155562,11 +155912,11 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + project: *724 + repository: *688 sender: *4 required: - action @@ -155647,8 +155997,8 @@ webhooks: type: string enum: - closed - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -155730,8 +156080,8 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -155813,8 +156163,8 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -155936,8 +156286,8 @@ webhooks: type: string to: type: string - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -156021,7 +156371,7 @@ webhooks: type: string enum: - archived - changes: &727 + changes: &728 type: object properties: archived_at: @@ -156037,9 +156387,9 @@ webhooks: - string - 'null' format: date-time - installation: *685 - organization: *686 - projects_v2_item: &724 + installation: *686 + organization: *687 + projects_v2_item: &725 title: Projects v2 Item description: An item belonging to a project type: object @@ -156179,9 +156529,9 @@ webhooks: - 'null' to: type: string - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156263,9 +156613,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156346,9 +156696,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156453,7 +156803,7 @@ webhooks: oneOf: - type: string - type: integer - - &725 + - &726 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156477,7 +156827,7 @@ webhooks: required: - id - name - - &726 + - &727 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156517,8 +156867,8 @@ webhooks: oneOf: - type: string - type: integer - - *725 - *726 + - *727 type: - 'null' - string @@ -156541,9 +156891,9 @@ webhooks: - 'null' required: - body - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156640,9 +156990,9 @@ webhooks: type: - string - 'null' - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156725,10 +157075,10 @@ webhooks: type: string enum: - restored - changes: *727 - installation: *685 - organization: *686 - projects_v2_item: *724 + changes: *728 + installation: *686 + organization: *687 + projects_v2_item: *725 sender: *4 required: - action @@ -156810,8 +157160,8 @@ webhooks: type: string enum: - reopened - installation: *685 - organization: *686 + installation: *686 + organization: *687 projects_v2: *241 sender: *4 required: @@ -156893,9 +157243,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *686 + organization: *687 + projects_v2_status_update: *729 sender: *4 required: - action @@ -156976,9 +157326,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *686 + organization: *687 + projects_v2_status_update: *729 sender: *4 required: - action @@ -157124,9 +157474,9 @@ webhooks: - string - 'null' format: date - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *686 + organization: *687 + projects_v2_status_update: *729 sender: *4 required: - action @@ -157197,10 +157547,10 @@ webhooks: title: public event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - repository @@ -157277,13 +157627,13 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - number: &729 + assignee: *705 + enterprise: *685 + installation: *686 + number: &730 description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -159632,7 +159982,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -159714,11 +160064,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -162060,7 +162410,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *688 sender: *4 required: - action @@ -162142,11 +162492,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -164488,7 +164838,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *688 sender: *4 required: - action @@ -164570,11 +164920,11 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: &730 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: &731 allOf: - *547 - type: object @@ -164638,7 +164988,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *687 + repository: *688 sender: *4 required: - action @@ -164719,12 +165069,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -164804,11 +165154,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 + enterprise: *685 milestone: *244 - number: *729 - organization: *686 - pull_request: &731 + number: *730 + organization: *687 + pull_request: &732 title: Pull Request type: object properties: @@ -167135,7 +167485,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -167214,11 +167564,11 @@ webhooks: type: string enum: - dequeued - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -169564,7 +169914,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *687 + repository: *688 sender: *4 required: - action @@ -169688,12 +170038,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -169773,11 +170123,11 @@ webhooks: type: string enum: - enqueued - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -172108,7 +172458,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -172188,11 +172538,11 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + label: *704 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -174540,7 +174890,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -174621,10 +174971,10 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -176970,7 +177320,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -177050,12 +177400,12 @@ webhooks: type: string enum: - milestoned - enterprise: *684 + enterprise: *685 milestone: *244 - number: *729 - organization: *686 - pull_request: *731 - repository: *687 + number: *730 + organization: *687 + pull_request: *732 + repository: *688 sender: *4 required: - action @@ -177134,12 +177484,12 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -177220,12 +177570,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -177305,12 +177655,12 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 + pull_request: *731 + repository: *688 sender: *4 required: - action @@ -177685,9 +178035,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: type: object properties: @@ -179917,7 +180267,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *688 sender: *4 required: - action @@ -179997,7 +180347,7 @@ webhooks: type: string enum: - deleted - comment: &733 + comment: &734 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -180290,9 +180640,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: type: object properties: @@ -182510,7 +182860,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *688 sender: *4 required: - action @@ -182590,11 +182940,11 @@ webhooks: type: string enum: - edited - changes: *732 - comment: *733 - enterprise: *684 - installation: *685 - organization: *686 + changes: *733 + comment: *734 + enterprise: *685 + installation: *686 + organization: *687 pull_request: type: object properties: @@ -184815,7 +185165,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *688 sender: *4 required: - action @@ -184896,9 +185246,9 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -187131,7 +187481,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *688 review: description: The review that was affected. type: object @@ -187382,9 +187732,9 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -189498,8 +189848,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: &734 + repository: *688 + review: &735 description: The review that was affected. type: object properties: @@ -189737,12 +190087,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -192089,7 +192439,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_reviewer: title: User type: @@ -192175,12 +192525,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -194534,7 +194884,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194729,12 +195079,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -197083,7 +197433,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_reviewer: title: User type: @@ -197170,12 +197520,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *685 + installation: *686 number: description: The pull request number. type: integer - organization: *686 + organization: *687 pull_request: title: Pull Request type: object @@ -199515,7 +199865,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199699,9 +200049,9 @@ webhooks: type: string enum: - submitted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -201937,8 +202287,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: *734 + repository: *688 + review: *735 sender: *4 required: - action @@ -202018,9 +202368,9 @@ webhooks: type: string enum: - resolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -204151,7 +204501,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *688 sender: *4 thread: type: object @@ -204548,9 +204898,9 @@ webhooks: type: string enum: - unresolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 pull_request: title: Simple Pull Request type: object @@ -206664,7 +207014,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *688 sender: *4 thread: type: object @@ -207063,10 +207413,10 @@ webhooks: type: string before: type: string - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -209401,7 +209751,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -209483,11 +209833,11 @@ webhooks: type: string enum: - unassigned - assignee: *735 - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + assignee: *736 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -211837,7 +212187,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -211916,11 +212266,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + label: *704 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -214259,7 +214609,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -214340,10 +214690,10 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *685 + installation: *686 + number: *730 + organization: *687 pull_request: title: Pull Request type: object @@ -216672,7 +217022,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *688 sender: *4 required: - action @@ -216875,7 +217225,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *684 + enterprise: *685 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216970,8 +217320,8 @@ webhooks: - url - author - committer - installation: *685 - organization: *686 + installation: *686 + organization: *687 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217559,9 +217909,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 registry_package: type: object properties: @@ -218038,7 +218388,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *718 + items: *719 summary: type: string tag_name: @@ -218094,7 +218444,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -218172,9 +218522,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 registry_package: type: object properties: @@ -218486,7 +218836,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *719 summary: type: string tag_name: @@ -218536,7 +218886,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *688 sender: *4 required: - action @@ -218613,10 +218963,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - release: &736 + enterprise: *685 + installation: *686 + organization: *687 + release: &737 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218947,7 +219297,7 @@ webhooks: - updated_at - zipball_url - body - repository: *687 + repository: *688 sender: *4 required: - action @@ -219024,11 +219374,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *737 + repository: *688 sender: *4 required: - action @@ -219145,11 +219495,11 @@ webhooks: type: boolean required: - to - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *737 + repository: *688 sender: *4 required: - action @@ -219227,9 +219577,9 @@ webhooks: type: string enum: - prereleased - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219565,7 +219915,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *688 sender: *4 required: - action @@ -219641,10 +219991,10 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - release: &737 + enterprise: *685 + installation: *686 + organization: *687 + release: &738 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219977,7 +220327,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *688 sender: *4 required: - action @@ -220053,11 +220403,11 @@ webhooks: type: string enum: - released - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *737 + repository: *688 sender: *4 required: - action @@ -220133,11 +220483,11 @@ webhooks: type: string enum: - unpublished - enterprise: *684 - installation: *685 - organization: *686 - release: *737 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + release: *738 + repository: *688 sender: *4 required: - action @@ -220213,11 +220563,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + repository_advisory: *612 sender: *4 required: - action @@ -220293,11 +220643,11 @@ webhooks: type: string enum: - reported - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + repository_advisory: *612 sender: *4 required: - action @@ -220373,10 +220723,10 @@ webhooks: type: string enum: - archived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220453,10 +220803,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220534,10 +220884,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220622,10 +220972,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220740,10 +221090,10 @@ webhooks: - 'null' items: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220815,10 +221165,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 status: type: string @@ -220899,10 +221249,10 @@ webhooks: type: string enum: - privatized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -220979,10 +221329,10 @@ webhooks: type: string enum: - publicized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221076,10 +221426,10 @@ webhooks: - name required: - repository - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221159,10 +221509,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 repository_ruleset: *283 sender: *4 required: @@ -221241,10 +221591,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 repository_ruleset: *283 sender: *4 required: @@ -221323,10 +221673,10 @@ webhooks: type: string enum: - edited - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 repository_ruleset: *283 changes: type: object @@ -221634,10 +221984,10 @@ webhooks: - from required: - owner - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221715,10 +222065,10 @@ webhooks: type: string enum: - unarchived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -221796,7 +222146,7 @@ webhooks: type: string enum: - create - alert: &738 + alert: &739 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221920,10 +222270,10 @@ webhooks: type: string enum: - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222133,10 +222483,10 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222214,11 +222564,11 @@ webhooks: type: string enum: - reopen - alert: *738 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *739 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222420,10 +222770,10 @@ webhooks: enum: - fixed - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222441,7 +222791,7 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -222449,8 +222799,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -222494,14 +222844,14 @@ webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &739 + - assigned + alert: &740 type: object properties: number: *154 @@ -222615,10 +222965,93 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + assignee: *4 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -222699,11 +223132,11 @@ webhooks: type: string enum: - created - alert: *739 - installation: *685 - location: *740 - organization: *686 - repository: *687 + alert: *740 + installation: *686 + location: *741 + organization: *687 + repository: *688 sender: *4 required: - location @@ -222941,11 +223374,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223023,11 +223456,11 @@ webhooks: type: string enum: - reopened - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223105,11 +223538,94 @@ webhooks: type: string enum: - resolved - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *740 + assignee: *4 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223187,11 +223703,11 @@ webhooks: type: string enum: - validated - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *740 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -223321,10 +223837,10 @@ webhooks: - organization - enterprise - - repository: *687 - enterprise: *684 - installation: *685 - organization: *686 + repository: *688 + enterprise: *685 + installation: *686 + organization: *687 sender: *4 required: - action @@ -223402,11 +223918,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: &741 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + security_advisory: &742 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223592,11 +224108,11 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: *741 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 + security_advisory: *742 sender: *4 required: - action @@ -223669,10 +224185,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223859,9 +224375,9 @@ webhooks: type: object properties: security_and_analysis: *257 - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: *317 sender: *4 required: @@ -223940,12 +224456,12 @@ webhooks: type: string enum: - cancelled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: &742 + sponsorship: &743 type: object properties: created_at: @@ -224250,12 +224766,12 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - sponsorship @@ -224343,12 +224859,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - changes @@ -224425,17 +224941,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &743 + effective_date: &744 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - sponsorship @@ -224509,7 +225025,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &744 + changes: &745 type: object properties: tier: @@ -224553,13 +225069,13 @@ webhooks: - from required: - tier - effective_date: *743 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + effective_date: *744 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - changes @@ -224636,13 +225152,13 @@ webhooks: type: string enum: - tier_changed - changes: *744 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + changes: *745 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - sponsorship: *742 + sponsorship: *743 required: - action - changes @@ -224716,10 +225232,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224803,10 +225319,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225240,15 +225756,15 @@ webhooks: type: - string - 'null' - enterprise: *684 + enterprise: *685 id: description: The unique identifier of the status. type: integer - installation: *685 + installation: *686 name: type: string - organization: *686 - repository: *687 + organization: *687 + repository: *688 sender: *4 sha: description: The Commit SHA. @@ -225364,9 +225880,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225456,9 +225972,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225548,9 +226064,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225640,9 +226156,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -225719,12 +226235,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - team: &745 + team: &746 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225954,9 +226470,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -226426,7 +226942,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -226502,9 +227018,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -226974,7 +227490,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -227051,9 +227567,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -227523,7 +228039,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -227667,9 +228183,9 @@ webhooks: - from required: - permissions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -228139,7 +228655,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - changes @@ -228217,9 +228733,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *685 + installation: *686 + organization: *687 repository: title: Repository description: A git repository @@ -228689,7 +229205,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *746 required: - action - team @@ -228765,10 +229281,10 @@ webhooks: type: string enum: - started - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 required: - action @@ -228841,17 +229357,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *684 + enterprise: *685 inputs: type: - object - 'null' additionalProperties: true - installation: *685 - organization: *686 + installation: *686 + organization: *687 ref: type: string - repository: *687 + repository: *688 sender: *4 workflow: type: string @@ -228933,10 +229449,10 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: allOf: @@ -229271,10 +229787,10 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: allOf: @@ -229635,10 +230151,10 @@ webhooks: type: string enum: - queued - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: type: object @@ -229863,10 +230379,10 @@ webhooks: type: string enum: - waiting - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 workflow_job: type: object @@ -230093,12 +230609,12 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Workflow Run type: object @@ -231117,12 +231633,12 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Workflow Run type: object @@ -232126,12 +232642,12 @@ webhooks: type: string enum: - requested - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *685 + installation: *686 + organization: *687 + repository: *688 sender: *4 - workflow: *699 + workflow: *700 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 1dd3c5f00..007705989 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -5459,6 +5459,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6607,6 +6615,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7528,6 +7544,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -8014,6 +8038,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10358,6 +10390,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11538,6 +11578,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12582,6 +12630,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13329,6 +13385,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -30285,6 +30349,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -31164,6 +31236,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -32263,6 +32343,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -33759,6 +33847,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -64308,6 +64404,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -68557,7 +68676,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } } } @@ -169635,6 +169769,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -170798,6 +170940,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -214077,21 +214227,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -246403,6 +246571,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -437538,6 +437729,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -613721,6 +613920,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -616507,7 +616729,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -616582,6 +616804,13 @@ "string", "null" ] + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] } }, "anyOf": [ @@ -616589,6 +616818,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -616598,6 +616832,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -617847,7 +618093,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -617861,7 +618127,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -711633,6 +711899,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -770950,6 +771224,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -778451,51 +778733,732 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for user", - "description": "Get a specific field for a user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "name": "project_number", - "description": "The project's number.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.", + "name": "project_number", + "description": "The project's number.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { @@ -778702,21 +779665,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -851229,6 +852210,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -854008,6 +854996,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -1010895,6 +1011890,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1014018,6 +1015021,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1017046,6 +1018057,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1020074,6 +1021093,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1023236,6 +1024263,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1026405,6 +1027440,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1031569,6 +1032612,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1498393,206 +1499444,4337 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "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": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1500468,7 +1505650,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1500484,23 +1505666,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1500565,15 +1505745,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "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).\"", @@ -1502448,6 +1507812,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1502463,21 +1507828,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1502544,13 +1507907,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1504623,11 +1509986,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1504694,13 +1510057,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1504711,9 +1510074,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1504733,12 +1510093,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1504838,9 +1510192,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1504882,7 +1510233,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1506757,285 +1512109,1126 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "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": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": [ - "object", - "null" - ], - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1508912,8 +1515105,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1508927,21 +1515119,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1509006,184 +1515199,856 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "url": { - "type": "string", - "format": "uri" } - } - }, - "external_identifier": { - "type": "string" + ] }, - "external_reference": { + "resolution_comment": { "type": [ "string", "null" ], - "format": "uri" + "description": "An optional comment to resolve an alert." }, - "fix_reason": { - "type": "string" + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." }, - "fixed_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "fixed_in": { - "type": "string" + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "id": { - "type": "integer" + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "node_id": { - "type": "string" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "severity": { - "type": "string" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] } } @@ -1511063,8 +1517928,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1511078,21 +1517942,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1511157,7 +1518022,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1512011,96 +1518876,6 @@ } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1512126,6 +1518901,354 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "examples": [ + "commit" + ] + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1513884,10 +1521007,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1513899,8 +1521197,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1513909,13 +1521208,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1513980,13 +1521279,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1514834,378 +1522133,120 @@ } } }, - "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).\"", + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, "id": { - "description": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", - "node_id" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1516965,185 +1524006,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1517155,9 +1524021,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1517166,11 +1524031,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1517237,13 +1524102,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1519989,11 +1526854,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1520060,13 +1526925,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1522812,11 +1529677,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1522883,13 +1529748,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1523737,6 +1530602,174 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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).\"", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 0aa137c96..9d52e34b9 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -915,7 +915,7 @@ paths: - subscriptions_url - type - url - type: &411 + type: &412 type: string description: The type of credit the user is receiving. enum: @@ -1081,7 +1081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &724 + - &725 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1810,7 +1810,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &734 + schema: &735 title: Scim Error description: Scim Error type: object @@ -2352,6 +2352,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -9101,7 +9108,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &735 + '401': &736 description: Authorization failure '404': *6 x-github: @@ -13366,7 +13373,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &516 + instances_url: &517 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13402,7 +13409,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &517 + dismissed_reason: &518 type: - string - 'null' @@ -13413,14 +13420,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &518 + dismissed_comment: &519 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &519 + rule: &520 type: object properties: id: @@ -13481,7 +13488,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &520 + tool: &521 type: object properties: name: *105 @@ -13492,15 +13499,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *106 - most_recent_instance: &521 + most_recent_instance: &522 type: object properties: - ref: &514 + ref: &515 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &531 + analysis_key: &532 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13511,7 +13518,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &532 + category: &533 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -17309,7 +17316,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &567 + - &568 name: has in: query description: |- @@ -17426,7 +17433,7 @@ paths: - direct - transitive - - security_advisory: &568 + security_advisory: &569 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17662,7 +17669,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: &569 + auto_dismissed_at: &570 type: - string - 'null' @@ -18807,7 +18814,7 @@ paths: - name - created_on examples: - default: &415 + default: &416 value: total_count: 2 network_configurations: @@ -19030,7 +19037,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &416 + - &417 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -19042,7 +19049,7 @@ paths: description: Response content: application/json: - schema: &417 + schema: &418 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -19081,7 +19088,7 @@ paths: - subnet_id - region examples: - default: &418 + default: &419 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -21134,7 +21141,7 @@ paths: - object rules: type: array - items: &690 + items: &691 title: Repository Rule type: object description: A repository rule. @@ -21143,7 +21150,7 @@ paths: - *160 - *161 - *162 - - &687 + - &688 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -21237,7 +21244,7 @@ paths: - *176 - *177 - *178 - - &688 + - &689 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21632,6 +21639,25 @@ paths: schema: type: string - &402 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &403 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -21647,7 +21673,7 @@ paths: - *17 - *102 - *103 - - &403 + - &404 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21656,7 +21682,7 @@ paths: required: false schema: type: string - - &404 + - &405 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21665,7 +21691,7 @@ paths: schema: type: boolean default: false - - &405 + - &406 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21674,7 +21700,7 @@ paths: schema: type: boolean default: false - - &406 + - &407 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21690,7 +21716,7 @@ paths: application/json: schema: type: array - items: &407 + items: &408 type: object properties: number: *119 @@ -21706,14 +21732,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &702 + state: &703 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &703 + resolution: &704 type: - string - 'null' @@ -21820,14 +21846,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &704 + - &705 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &706 + - &707 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21884,7 +21910,7 @@ paths: - blob_url - commit_sha - commit_url - - &707 + - &708 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -21945,7 +21971,7 @@ paths: - page_url - commit_sha - commit_url - - &708 + - &709 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21960,7 +21986,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &709 + - &710 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21975,7 +22001,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &710 + - &711 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21990,7 +22016,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &711 + - &712 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -22005,7 +22031,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &712 + - &713 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -22020,7 +22046,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &713 + - &714 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -22035,7 +22061,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &714 + - &715 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -22050,7 +22076,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &715 + - &716 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -22065,7 +22091,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &716 + - &717 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -22080,7 +22106,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &717 + - &718 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -22095,7 +22121,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &718 + - &719 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -22120,7 +22146,7 @@ paths: - type: 'null' - *4 examples: - default: &408 + default: &409 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -22329,7 +22355,7 @@ paths: description: Response content: application/json: - schema: &409 + schema: &410 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -22416,7 +22442,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *185 examples: - default: &410 + default: &411 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -22552,7 +22578,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &412 + - &413 name: advanced_security_product in: query description: | @@ -22572,7 +22598,7 @@ paths: description: Success content: application/json: - schema: &413 + schema: &414 type: object properties: total_advanced_security_committers: @@ -22635,7 +22661,7 @@ paths: required: - repositories examples: - default: &414 + default: &415 value: total_advanced_security_committers: 2 total_count: 2 @@ -23287,7 +23313,19 @@ paths: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *23 '403': *27 @@ -25782,7 +25820,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &762 + sub_issues_summary: &763 title: Sub-issues Summary type: object properties: @@ -25803,7 +25841,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &763 + issue_dependencies_summary: &764 title: Issue Dependencies Summary type: object properties: @@ -25822,7 +25860,7 @@ paths: - total_blocking issue_field_values: type: array - items: &764 + items: &765 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25917,7 +25955,7 @@ paths: - user - created_at - updated_at - comment: &625 + comment: &626 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -26483,7 +26521,7 @@ paths: url: type: string format: uri - user: &776 + user: &777 title: Public User description: Public User type: object @@ -29840,14 +29878,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &438 + - &439 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &439 + - &440 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29909,7 +29947,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &450 + '301': &451 description: Moved permanently content: application/json: @@ -29931,7 +29969,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &654 + - &655 name: all description: If `true`, show notifications marked as read. in: query @@ -29939,7 +29977,7 @@ paths: schema: type: boolean default: false - - &655 + - &656 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29949,7 +29987,7 @@ paths: type: boolean default: false - *209 - - &656 + - &657 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -30493,7 +30531,7 @@ paths: - url - subscription_url examples: - default: &657 + default: &658 value: - id: '1' repository: @@ -31474,7 +31512,7 @@ paths: type: array items: *145 examples: - default: &663 + default: &664 value: - property_name: environment value: production @@ -31524,7 +31562,7 @@ paths: required: - properties examples: - default: &664 + default: &665 value: properties: - property_name: environment @@ -32415,7 +32453,7 @@ paths: type: integer repository_cache_usages: type: array - items: &455 + items: &456 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -34538,7 +34576,7 @@ paths: type: array items: *263 examples: - default: &779 + default: &780 value: total_count: 1 repositories: @@ -35582,7 +35620,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &476 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -35617,7 +35655,7 @@ paths: - key_id - key examples: - default: &476 + default: &477 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -36030,7 +36068,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *81 - - &460 + - &461 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -37237,12 +37275,12 @@ paths: required: - subject_digests examples: - default: &806 + default: &807 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &807 + withPredicateType: &808 value: subject_digests: - sha256:abc123 @@ -37301,7 +37339,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &808 + default: &809 value: attestations_subject_digests: - sha256:abc: @@ -37650,7 +37688,7 @@ paths: initiator: type: string examples: - default: &489 + default: &490 value: attestations: - bundle: @@ -38572,7 +38610,7 @@ paths: be returned. in: query required: false - schema: &515 + schema: &516 type: string description: Severity of a code scanning alert. enum: @@ -39623,7 +39661,7 @@ paths: machine: anyOf: - type: 'null' - - &544 + - &545 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -40575,7 +40613,7 @@ paths: - updated_at - visibility examples: - default: &545 + default: &546 value: total_count: 2 secrets: @@ -40613,7 +40651,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &547 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -40648,7 +40686,7 @@ paths: - key_id - key examples: - default: &547 + default: &548 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40680,7 +40718,7 @@ paths: application/json: schema: *307 examples: - default: &549 + default: &550 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -42409,7 +42447,7 @@ paths: description: Response content: application/json: - schema: &572 + schema: &573 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -42428,7 +42466,7 @@ paths: - key_id - key examples: - default: &573 + default: &574 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -42758,7 +42796,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *81 - - &581 + - &582 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -42766,7 +42804,7 @@ paths: required: false schema: type: string - - &582 + - &583 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -42774,7 +42812,7 @@ paths: required: false schema: type: string - - &583 + - &584 name: time_period description: |- The time period to filter by. @@ -42790,7 +42828,7 @@ paths: - week - month default: month - - &584 + - &585 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -42815,7 +42853,7 @@ paths: application/json: schema: type: array - items: &585 + items: &586 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -42978,7 +43016,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &586 + default: &587 value: - id: 21 number: 42 @@ -43069,7 +43107,7 @@ paths: - *97 - *98 - *99 - - &587 + - &588 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -43095,7 +43133,7 @@ paths: application/json: schema: type: array - items: &588 + items: &589 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -43222,7 +43260,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &589 + default: &590 value: - id: 21 number: 42 @@ -43568,7 +43606,7 @@ paths: description: Response content: application/json: - schema: &433 + schema: &434 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -43658,7 +43696,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &434 + default: &435 value: group_id: '123' group_name: Octocat admins @@ -43713,7 +43751,7 @@ paths: description: Response content: application/json: - schema: &431 + schema: &432 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -43753,7 +43791,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &432 + default: &433 value: groups: - group_id: '123' @@ -45082,7 +45120,7 @@ paths: application/json: schema: *20 examples: - default: &620 + default: &621 value: id: 1 account: @@ -45310,7 +45348,7 @@ paths: required: true content: application/json: - schema: &621 + schema: &622 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -46178,7 +46216,7 @@ paths: application/json: schema: *352 examples: - default: &543 + default: &544 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -47436,7 +47474,7 @@ paths: parameters: - *81 - *358 - - &791 + - &792 name: repo_name description: repo_name parameter in: path @@ -48782,7 +48820,7 @@ paths: - nuget - container - *81 - - &792 + - &793 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -48823,7 +48861,7 @@ paths: default: *363 '403': *27 '401': *23 - '400': &794 + '400': &795 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -50649,7 +50687,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &868 + - &869 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -50923,7 +50961,7 @@ paths: content: oneOf: - *219 - - &556 + - &557 title: Pull Request Simple description: Pull Request Simple type: object @@ -51168,7 +51206,7 @@ paths: - review_comment - self author_association: *206 - auto_merge: &666 + auto_merge: &667 title: Auto merge description: The status of auto merging a pull request. type: @@ -51550,7 +51588,7 @@ paths: - updated_at - project_url examples: - default: &811 + default: &812 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -51682,7 +51720,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - *380 - - &812 + - &813 name: field_id description: The unique identifier of the field. in: path @@ -51697,7 +51735,7 @@ paths: application/json: schema: *383 examples: - default: &813 + default: &814 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -51706,17 +51744,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -53487,7 +53537,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &450 title: Full Repository description: Full Repository type: object @@ -53952,7 +54002,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &561 + code_of_conduct: &562 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -54066,7 +54116,7 @@ paths: - network_count - subscribers_count examples: - default: &451 + default: &452 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -54619,7 +54669,7 @@ paths: - *81 - *17 - *19 - - &689 + - &690 name: targets description: | A comma-separated list of rule targets to filter by. @@ -54834,7 +54884,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *81 - - &691 + - &692 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -54846,14 +54896,14 @@ paths: x-multi-segment: true - *289 - *99 - - &692 + - &693 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &693 + - &694 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -54873,7 +54923,7 @@ paths: description: Response content: application/json: - schema: &694 + schema: &695 title: Rule Suites description: Response type: array @@ -54929,7 +54979,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &695 + default: &696 value: - id: 21 actor_id: 12 @@ -54973,7 +55023,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *81 - - &696 + - &697 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -54989,7 +55039,7 @@ paths: description: Response content: application/json: - schema: &697 + schema: &698 title: Rule Suite description: Response type: object @@ -55096,7 +55146,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &698 + default: &699 value: id: 21 actor_id: 12 @@ -55424,10 +55474,11 @@ paths: - *400 - *401 - *402 + - *403 - *104 - *19 - *17 - - &700 + - &701 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -55437,7 +55488,7 @@ paths: required: false schema: type: string - - &701 + - &702 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -55447,10 +55498,10 @@ paths: required: false schema: type: string - - *403 - *404 - *405 - *406 + - *407 responses: '200': description: Response @@ -55458,9 +55509,9 @@ paths: application/json: schema: type: array - items: *407 + items: *408 examples: - default: *408 + default: *409 headers: Link: *41 '404': *6 @@ -55495,9 +55546,9 @@ paths: description: Response content: application/json: - schema: *409 + schema: *410 examples: - default: *410 + default: *411 '403': *27 '404': *6 patch: @@ -55650,7 +55701,7 @@ paths: application/json: schema: type: array - items: &722 + items: &723 description: A repository security advisory. type: object properties: @@ -55894,7 +55945,7 @@ paths: login: type: string description: The username of the user credited. - type: *411 + type: *412 credits_detailed: type: - array @@ -55905,7 +55956,7 @@ paths: type: object properties: user: *4 - type: *411 + type: *412 state: type: string description: The state of the user's acceptance of the @@ -55969,7 +56020,7 @@ paths: - private_fork additionalProperties: false examples: - default: &723 + default: &724 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -56440,7 +56491,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *81 - - *412 + - *413 - *17 - *19 responses: @@ -56448,9 +56499,9 @@ paths: description: Success content: application/json: - schema: *413 + schema: *414 examples: - default: *414 + default: *415 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -56733,7 +56784,7 @@ paths: type: array items: *137 examples: - default: *415 + default: *416 headers: Link: *41 x-github: @@ -56934,15 +56985,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *81 - - *416 + - *417 responses: '200': description: Response content: application/json: - schema: *417 + schema: *418 examples: - default: *418 + default: *419 headers: Link: *41 x-github: @@ -56980,7 +57031,7 @@ paths: description: Response content: application/json: - schema: &440 + schema: &441 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -57032,7 +57083,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &441 + default: &442 value: groups: - group_id: '123' @@ -57240,7 +57291,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &420 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -57639,7 +57690,7 @@ paths: - repos_count - organization examples: - default: &420 + default: &421 value: id: 1 node_id: MDQ6VGVhbTE= @@ -57716,9 +57767,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 x-github: githubCloudOnly: false @@ -57803,16 +57854,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '201': description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 '422': *15 '403': *27 @@ -57882,7 +57933,7 @@ paths: application/json: schema: type: array - items: &421 + items: &422 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -57993,7 +58044,7 @@ paths: - updated_at - url examples: - default: &766 + default: &767 value: - author: login: octocat @@ -58102,9 +58153,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: &422 + default: &423 value: author: login: octocat @@ -58178,7 +58229,7 @@ paths: parameters: - *81 - *204 - - &423 + - &424 name: discussion_number description: The number that identifies the discussion. in: path @@ -58190,9 +58241,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *422 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58216,7 +58267,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 requestBody: required: false content: @@ -58239,9 +58290,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: &767 + default: &768 value: author: login: octocat @@ -58313,7 +58364,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 responses: '204': description: Response @@ -58341,7 +58392,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 - *104 - *17 - *19 @@ -58352,7 +58403,7 @@ paths: application/json: schema: type: array - items: &424 + items: &425 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -58432,7 +58483,7 @@ paths: - updated_at - url examples: - default: &768 + default: &769 value: - author: login: octocat @@ -58502,7 +58553,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 requestBody: required: true content: @@ -58524,9 +58575,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: &425 + default: &426 value: author: login: octocat @@ -58594,8 +58645,8 @@ paths: parameters: - *81 - *204 - - *423 - - &426 + - *424 + - &427 name: comment_number description: The number that identifies the comment. in: path @@ -58607,9 +58658,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *425 + default: *426 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58633,8 +58684,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 requestBody: required: true content: @@ -58656,9 +58707,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: &769 + default: &770 value: author: login: octocat @@ -58724,8 +58775,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 responses: '204': description: Response @@ -58753,8 +58804,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -58780,7 +58831,7 @@ paths: application/json: schema: type: array - items: &427 + items: &428 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -58824,7 +58875,7 @@ paths: - content - created_at examples: - default: &429 + default: &430 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58876,8 +58927,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 requestBody: required: true content: @@ -58910,9 +58961,9 @@ paths: team discussion comment content: application/json: - schema: *427 + schema: *428 examples: - default: &428 + default: &429 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58941,9 +58992,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58968,9 +59019,9 @@ paths: parameters: - *81 - *204 - - *423 - - *426 - - &430 + - *424 + - *427 + - &431 name: reaction_id description: The unique identifier of the reaction. in: path @@ -59004,7 +59055,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -59030,9 +59081,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 x-github: @@ -59060,7 +59111,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 requestBody: required: true content: @@ -59092,16 +59143,16 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59126,8 +59177,8 @@ paths: parameters: - *81 - *204 - - *423 - - *430 + - *424 + - *431 responses: '204': description: Response @@ -59157,9 +59208,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *432 examples: - default: *432 + default: *433 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -59203,9 +59254,9 @@ paths: description: Response content: application/json: - schema: *433 + schema: *434 examples: - default: *434 + default: *435 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59346,7 +59397,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &436 title: Team Membership description: Team Membership type: object @@ -59374,7 +59425,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &770 + response-if-user-is-a-team-maintainer: &771 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -59437,9 +59488,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *436 examples: - response-if-users-membership-with-team-is-now-pending: &771 + response-if-users-membership-with-team-is-now-pending: &772 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -59512,7 +59563,7 @@ paths: application/json: schema: type: array - items: &436 + items: &437 title: Team Project description: A team's access to a project. type: object @@ -59581,7 +59632,7 @@ paths: - updated_at - permissions examples: - default: &772 + default: &773 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59646,7 +59697,7 @@ paths: parameters: - *81 - *204 - - &437 + - &438 name: project_id description: The unique identifier of the project. in: path @@ -59658,9 +59709,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *437 examples: - default: &773 + default: &774 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59724,7 +59775,7 @@ paths: parameters: - *81 - *204 - - *437 + - *438 requestBody: required: false content: @@ -59793,7 +59844,7 @@ paths: parameters: - *81 - *204 - - *437 + - *438 responses: '204': description: Response @@ -59864,14 +59915,14 @@ paths: parameters: - *81 - *204 - - *438 - *439 + - *440 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &774 + schema: &775 title: Team Repository description: A team's access to a repository. type: object @@ -60514,8 +60565,8 @@ paths: parameters: - *81 - *204 - - *438 - *439 + - *440 requestBody: required: false content: @@ -60562,8 +60613,8 @@ paths: parameters: - *81 - *204 - - *438 - *439 + - *440 responses: '204': description: Response @@ -60596,9 +60647,9 @@ paths: description: Response content: application/json: - schema: *440 + schema: *441 examples: - default: *441 + default: *442 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60664,7 +60715,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *441 examples: default: value: @@ -60709,7 +60760,7 @@ paths: type: array items: *292 examples: - response-if-child-teams-exist: &775 + response-if-child-teams-exist: &776 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -60836,7 +60887,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &442 + - &443 name: card_id description: The unique identifier of the card. in: path @@ -60848,7 +60899,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &444 title: Project Card description: Project cards represent a scope of work. type: object @@ -60923,7 +60974,7 @@ paths: - created_at - updated_at examples: - default: &444 + default: &445 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -60979,7 +61030,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *442 + - *443 requestBody: required: false content: @@ -61009,9 +61060,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *444 examples: - default: *444 + default: *445 '304': *35 '403': *27 '401': *23 @@ -61038,7 +61089,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *442 + - *443 responses: '204': description: Response @@ -61082,7 +61133,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *442 + - *443 requestBody: required: true content: @@ -61195,7 +61246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &445 + - &446 name: column_id description: The unique identifier of the column. in: path @@ -61207,7 +61258,7 @@ paths: description: Response content: application/json: - schema: &446 + schema: &447 title: Project Column description: Project columns contain cards of work. type: object @@ -61261,7 +61312,7 @@ paths: - created_at - updated_at examples: - default: &447 + default: &448 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -61296,7 +61347,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *445 + - *446 requestBody: required: true content: @@ -61321,9 +61372,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *447 examples: - default: *447 + default: *448 '304': *35 '403': *27 '401': *23 @@ -61348,7 +61399,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *445 + - *446 responses: '204': description: Response @@ -61377,7 +61428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *445 + - *446 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -61398,7 +61449,7 @@ paths: application/json: schema: type: array - items: *443 + items: *444 examples: default: value: @@ -61457,7 +61508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *445 + - *446 requestBody: required: true content: @@ -61501,9 +61552,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *444 examples: - default: *444 + default: *445 '304': *35 '403': *27 '401': *23 @@ -61559,7 +61610,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *445 + - *446 requestBody: required: true content: @@ -61620,7 +61671,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *437 + - *438 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -61677,7 +61728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *437 + - *438 - *132 requestBody: required: false @@ -61732,7 +61783,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *437 + - *438 - *132 responses: '204': @@ -61764,7 +61815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *437 + - *438 - *132 responses: '200': @@ -61862,7 +61913,7 @@ paths: resources: type: object properties: - core: &448 + core: &449 title: Rate Limit type: object properties: @@ -61879,21 +61930,21 @@ paths: - remaining - reset - used - graphql: *448 - search: *448 - code_search: *448 - source_import: *448 - integration_manifest: *448 - code_scanning_upload: *448 - actions_runner_registration: *448 - scim: *448 - dependency_snapshots: *448 - dependency_sbom: *448 - code_scanning_autofix: *448 + graphql: *449 + search: *449 + code_search: *449 + source_import: *449 + integration_manifest: *449 + code_scanning_upload: *449 + actions_runner_registration: *449 + scim: *449 + dependency_snapshots: *449 + dependency_sbom: *449 + code_scanning_autofix: *449 required: - core - search - rate: *448 + rate: *449 required: - rate - resources @@ -61998,14 +62049,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *449 + schema: *450 examples: default-response: summary: Default response @@ -62510,7 +62561,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *450 + '301': *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62528,8 +62579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -62787,10 +62838,10 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 - '307': &452 + default: *452 + '307': &453 description: Temporary Redirect content: application/json: @@ -62819,8 +62870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -62842,7 +62893,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *452 + '307': *453 '404': *6 '409': *112 x-github: @@ -62866,11 +62917,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 - - &467 + - &468 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -62893,7 +62944,7 @@ paths: type: integer artifacts: type: array - items: &453 + items: &454 title: Artifact description: An artifact type: object @@ -62988,7 +63039,7 @@ paths: - expires_at - updated_at examples: - default: &468 + default: &469 value: total_count: 2 artifacts: @@ -63049,9 +63100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *438 - *439 - - &454 + - *440 + - &455 name: artifact_id description: The unique identifier of the artifact. in: path @@ -63063,7 +63114,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: default: value: @@ -63101,9 +63152,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *438 - *439 - - *454 + - *440 + - *455 responses: '204': description: Response @@ -63127,9 +63178,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *438 - *439 - - *454 + - *440 + - *455 - name: archive_format in: path required: true @@ -63143,7 +63194,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &624 + '410': &625 description: Gone content: application/json: @@ -63170,14 +63221,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *455 + schema: *456 examples: default: value: @@ -63203,11 +63254,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 - - &456 + - &457 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -63241,7 +63292,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &458 title: Repository actions caches description: Repository actions caches type: object @@ -63291,7 +63342,7 @@ paths: - total_count - actions_caches examples: - default: &458 + default: &459 value: total_count: 1 actions_caches: @@ -63323,23 +63374,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *438 - *439 + - *440 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *456 + - *457 responses: '200': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63359,8 +63410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *438 - *439 + - *440 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63391,9 +63442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *438 - *439 - - &459 + - *440 + - &460 name: job_id description: The unique identifier of the job. in: path @@ -63405,7 +63456,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &472 title: Job description: Information of a job execution in a workflow run type: object @@ -63752,9 +63803,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *438 - *439 - - *459 + - *440 + - *460 responses: '302': description: Response @@ -63782,9 +63833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *438 - *439 - - *459 + - *440 + - *460 requestBody: required: false content: @@ -63830,8 +63881,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Status response @@ -63881,8 +63932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -63945,8 +63996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -63964,7 +64015,7 @@ paths: type: integer secrets: type: array - items: &473 + items: &474 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -63985,7 +64036,7 @@ paths: - created_at - updated_at examples: - default: &474 + default: &475 value: total_count: 2 secrets: @@ -64018,9 +64069,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *438 - *439 - - *460 + - *440 + - *461 - *19 responses: '200': @@ -64037,7 +64088,7 @@ paths: type: integer variables: type: array - items: &477 + items: &478 title: Actions Variable type: object properties: @@ -64071,7 +64122,7 @@ paths: - created_at - updated_at examples: - default: &478 + default: &479 value: total_count: 2 variables: @@ -64104,8 +64155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64114,7 +64165,7 @@ paths: schema: type: object properties: - enabled: &461 + enabled: &462 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *54 @@ -64149,8 +64200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -64161,7 +64212,7 @@ paths: schema: type: object properties: - enabled: *461 + enabled: *462 allowed_actions: *54 sha_pinning_required: *55 required: @@ -64194,14 +64245,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: &462 + schema: &463 type: object properties: access_level: @@ -64219,7 +64270,7 @@ paths: required: - access_level examples: - default: &463 + default: &464 value: access_level: organization x-github: @@ -64244,15 +64295,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: application/json: - schema: *462 + schema: *463 examples: - default: *463 + default: *464 responses: '204': description: Response @@ -64276,8 +64327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64307,8 +64358,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Empty response for successful settings update @@ -64342,8 +64393,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64370,8 +64421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -64405,8 +64456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64434,8 +64485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -64466,8 +64517,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64498,8 +64549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -64531,8 +64582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64561,8 +64612,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Success response @@ -64602,8 +64653,8 @@ paths: in: query schema: type: string - - *438 - *439 + - *440 - *17 - *19 responses: @@ -64647,8 +64698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64680,8 +64731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -64755,8 +64806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *438 - *439 + - *440 responses: '201': description: Response @@ -64792,8 +64843,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *438 - *439 + - *440 responses: '201': description: Response @@ -64823,8 +64874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '200': @@ -64854,8 +64905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '204': @@ -64882,8 +64933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '200': *75 @@ -64908,8 +64959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 requestBody: required: true @@ -64958,8 +65009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 requestBody: required: true @@ -65009,8 +65060,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '200': *270 @@ -65040,8 +65091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 - *271 responses: @@ -65071,9 +65122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *438 - *439 - - &481 + - *440 + - &482 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -65081,7 +65132,7 @@ paths: required: false schema: type: string - - &482 + - &483 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -65089,7 +65140,7 @@ paths: required: false schema: type: string - - &483 + - &484 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -65098,7 +65149,7 @@ paths: required: false schema: type: string - - &484 + - &485 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -65125,7 +65176,7 @@ paths: - pending - *17 - *19 - - &485 + - &486 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -65134,7 +65185,7 @@ paths: schema: type: string format: date-time - - &464 + - &465 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -65143,13 +65194,13 @@ paths: schema: type: boolean default: false - - &486 + - &487 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &487 + - &488 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -65172,7 +65223,7 @@ paths: type: integer workflow_runs: type: array - items: &465 + items: &466 title: Workflow Run description: An invocation of a workflow type: object @@ -65289,7 +65340,7 @@ paths: type: - array - 'null' - items: &506 + items: &507 title: Pull Request Minimal type: object properties: @@ -65416,7 +65467,7 @@ paths: head_commit: anyOf: - type: 'null' - - &510 + - &511 title: Simple Commit description: A commit. type: object @@ -65531,7 +65582,7 @@ paths: - workflow_url - pull_requests examples: - default: &488 + default: &489 value: total_count: 1 workflow_runs: @@ -65767,24 +65818,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *438 - *439 - - &466 + - *440 + - &467 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *464 + - *465 responses: '200': description: Response content: application/json: - schema: *465 + schema: *466 examples: - default: &469 + default: &470 value: id: 30433642 name: Build @@ -66025,9 +66076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '204': description: Response @@ -66050,9 +66101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '200': description: Response @@ -66180,9 +66231,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '201': description: Response @@ -66215,12 +66266,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *438 - *439 - - *466 + - *440 + - *467 - *17 - *19 - - *467 + - *468 responses: '200': description: Response @@ -66236,9 +66287,9 @@ paths: type: integer artifacts: type: array - items: *453 + items: *454 examples: - default: *468 + default: *469 headers: Link: *41 x-github: @@ -66262,25 +66313,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *438 - *439 - - *466 - - &470 + - *440 + - *467 + - &471 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *464 + - *465 responses: '200': description: Response content: application/json: - schema: *465 + schema: *466 examples: - default: *469 + default: *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66303,10 +66354,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *438 - *439 - - *466 - - *470 + - *440 + - *467 + - *471 - *17 - *19 responses: @@ -66324,9 +66375,9 @@ paths: type: integer jobs: type: array - items: *471 + items: *472 examples: - default: &472 + default: &473 value: total_count: 1 jobs: @@ -66439,10 +66490,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *438 - *439 - - *466 - - *470 + - *440 + - *467 + - *471 responses: '302': description: Response @@ -66470,9 +66521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '202': description: Response @@ -66505,9 +66556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: true content: @@ -66574,9 +66625,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '202': description: Response @@ -66609,9 +66660,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -66641,9 +66692,9 @@ paths: type: integer jobs: type: array - items: *471 + items: *472 examples: - default: *472 + default: *473 headers: Link: *41 x-github: @@ -66668,9 +66719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '302': description: Response @@ -66697,9 +66748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '204': description: Response @@ -66726,9 +66777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '200': description: Response @@ -66797,7 +66848,7 @@ paths: items: type: object properties: - type: &590 + type: &591 type: string description: The type of reviewer. enum: @@ -66883,9 +66934,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: true content: @@ -66935,7 +66986,7 @@ paths: application/json: schema: type: array - items: &576 + items: &577 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -67047,7 +67098,7 @@ paths: - created_at - updated_at examples: - default: &577 + default: &578 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -67103,9 +67154,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: false content: @@ -67150,9 +67201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: false content: @@ -67207,9 +67258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '200': description: Response @@ -67346,8 +67397,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -67365,9 +67416,9 @@ paths: type: integer secrets: type: array - items: *473 + items: *474 examples: - default: *474 + default: *475 headers: Link: *41 x-github: @@ -67392,16 +67443,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *475 + schema: *476 examples: - default: *476 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67423,17 +67474,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '200': description: Response content: application/json: - schema: *473 + schema: *474 examples: - default: &603 + default: &604 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -67459,8 +67510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 requestBody: required: true @@ -67518,8 +67569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '204': @@ -67545,9 +67596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *438 - *439 - - *460 + - *440 + - *461 - *19 responses: '200': @@ -67564,9 +67615,9 @@ paths: type: integer variables: type: array - items: *477 + items: *478 examples: - default: *478 + default: *479 headers: Link: *41 x-github: @@ -67589,8 +67640,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -67642,17 +67693,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *438 - *439 + - *440 - *276 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: &604 + default: &605 value: name: USERNAME value: octocat @@ -67678,8 +67729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *438 - *439 + - *440 - *276 requestBody: required: true @@ -67722,8 +67773,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *438 - *439 + - *440 - *276 responses: '204': @@ -67749,8 +67800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -67768,7 +67819,7 @@ paths: type: integer workflows: type: array - items: &479 + items: &480 title: Workflow description: A GitHub Actions workflow type: object @@ -67886,9 +67937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *438 - *439 - - &480 + - *440 + - &481 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -67903,7 +67954,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: default: value: @@ -67936,9 +67987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '204': description: Response @@ -67963,9 +68014,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '204': description: Response @@ -68016,9 +68067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '204': description: Response @@ -68045,19 +68096,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *438 - *439 - - *480 + - *440 - *481 - *482 - *483 - *484 + - *485 - *17 - *19 - - *485 - - *464 - *486 + - *465 - *487 + - *488 responses: '200': description: Response @@ -68073,9 +68124,9 @@ paths: type: integer workflow_runs: type: array - items: *465 + items: *466 examples: - default: *488 + default: *489 headers: Link: *41 x-github: @@ -68108,9 +68159,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '200': description: Response @@ -68171,8 +68222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *438 - *439 + - *440 - *104 - *17 - *102 @@ -68340,8 +68391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -68378,8 +68429,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *438 - *439 + - *440 - name: assignee in: path required: true @@ -68415,8 +68466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -68528,8 +68579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *438 - *439 + - *440 - *17 - *102 - *103 @@ -68586,7 +68637,7 @@ paths: initiator: type: string examples: - default: *489 + default: *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68606,8 +68657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -68615,7 +68666,7 @@ paths: application/json: schema: type: array - items: &490 + items: &491 title: Autolink reference description: An autolink reference. type: object @@ -68674,8 +68725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -68714,9 +68765,9 @@ paths: description: response content: application/json: - schema: *490 + schema: *491 examples: - default: &491 + default: &492 value: id: 1 key_prefix: TICKET- @@ -68747,9 +68798,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *438 - *439 - - &492 + - *440 + - &493 name: autolink_id description: The unique identifier of the autolink. in: path @@ -68761,9 +68812,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *491 examples: - default: *491 + default: *492 '404': *6 x-github: githubCloudOnly: false @@ -68783,9 +68834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *438 - *439 - - *492 + - *440 + - *493 responses: '204': description: Response @@ -68809,8 +68860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response if Dependabot is enabled @@ -68860,8 +68911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -68882,8 +68933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -68903,8 +68954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *438 - *439 + - *440 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -68942,7 +68993,7 @@ paths: - url protected: type: boolean - protection: &494 + protection: &495 title: Branch Protection description: Branch Protection type: object @@ -68985,7 +69036,7 @@ paths: required: - contexts - checks - enforce_admins: &497 + enforce_admins: &498 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -69002,7 +69053,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &499 + required_pull_request_reviews: &500 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -69086,7 +69137,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &496 + restrictions: &497 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -69379,9 +69430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *438 - *439 - - &495 + - *440 + - &496 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -69395,14 +69446,14 @@ paths: description: Response content: application/json: - schema: &505 + schema: &506 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &552 + commit: &553 title: Commit description: Commit type: object @@ -69441,7 +69492,7 @@ paths: author: anyOf: - type: 'null' - - &493 + - &494 title: Git User description: Metaproperties for Git author/committer information. @@ -69462,7 +69513,7 @@ paths: committer: anyOf: - type: 'null' - - *493 + - *494 message: type: string examples: @@ -69486,7 +69537,7 @@ paths: required: - sha - url - verification: &610 + verification: &611 title: Verification type: object properties: @@ -69566,7 +69617,7 @@ paths: type: integer files: type: array - items: &563 + items: &564 title: Diff Entry description: Diff Entry type: object @@ -69662,7 +69713,7 @@ paths: - self protected: type: boolean - protection: *494 + protection: *495 protection_url: type: string format: uri @@ -69771,7 +69822,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *450 + '301': *451 '404': *6 x-github: githubCloudOnly: false @@ -69793,15 +69844,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: default: value: @@ -69995,9 +70046,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -70257,7 +70308,7 @@ paths: url: type: string format: uri - required_status_checks: &502 + required_status_checks: &503 title: Status Check Policy description: Status Check Policy type: object @@ -70416,7 +70467,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *496 + restrictions: *497 required_conversation_resolution: type: object properties: @@ -70528,9 +70579,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70555,17 +70606,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: &498 + default: &499 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -70587,17 +70638,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: *498 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70616,9 +70667,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70643,17 +70694,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: &500 + default: &501 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -70749,9 +70800,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -70849,9 +70900,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: *500 + default: *501 '422': *15 x-github: githubCloudOnly: false @@ -70872,9 +70923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70901,17 +70952,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: &501 + default: &502 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -70934,17 +70985,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: *501 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -70964,9 +71015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70991,17 +71042,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *502 + schema: *503 examples: - default: &503 + default: &504 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -71027,9 +71078,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71081,9 +71132,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: - default: *503 + default: *504 '404': *6 '422': *15 x-github: @@ -71105,9 +71156,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -71131,9 +71182,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71167,9 +71218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71236,9 +71287,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71302,9 +71353,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: content: application/json: @@ -71370,15 +71421,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: default: value: @@ -71469,9 +71520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -71494,9 +71545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71506,7 +71557,7 @@ paths: type: array items: *5 examples: - default: &504 + default: &505 value: - id: 1 slug: octoapp @@ -71563,9 +71614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -71599,7 +71650,7 @@ paths: type: array items: *5 examples: - default: *504 + default: *505 '422': *15 x-github: githubCloudOnly: false @@ -71620,9 +71671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -71656,7 +71707,7 @@ paths: type: array items: *5 examples: - default: *504 + default: *505 '422': *15 x-github: githubCloudOnly: false @@ -71677,9 +71728,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -71713,7 +71764,7 @@ paths: type: array items: *5 examples: - default: *504 + default: *505 '422': *15 x-github: githubCloudOnly: false @@ -71735,9 +71786,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71767,9 +71818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71828,9 +71879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71889,9 +71940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: content: application/json: @@ -71950,9 +72001,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71986,9 +72037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72046,9 +72097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72106,9 +72157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72168,9 +72219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72192,7 +72243,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *506 examples: default: value: @@ -72306,8 +72357,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *438 - *439 + - *440 - *97 - *98 - *99 @@ -72343,8 +72394,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *438 - *439 + - *440 - name: bypass_request_number in: path required: true @@ -72417,8 +72468,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - *97 - *98 - *99 @@ -72458,8 +72509,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - name: bypass_request_number in: path required: true @@ -72529,8 +72580,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - name: bypass_request_number in: path required: true @@ -72601,8 +72652,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - name: bypass_response_id in: path required: true @@ -72635,8 +72686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -72915,7 +72966,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &508 title: CheckRun description: A check performed on the code of a given code change type: object @@ -73050,8 +73101,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *506 - deployment: &824 + items: *507 + deployment: &825 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -73338,9 +73389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *438 - *439 - - &508 + - *440 + - &509 name: check_run_id description: The unique identifier of the check run. in: path @@ -73352,9 +73403,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: &509 + default: &510 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -73454,9 +73505,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *438 - *439 - - *508 + - *440 + - *509 requestBody: required: true content: @@ -73696,9 +73747,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *509 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73718,9 +73769,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *438 - *439 - - *508 + - *440 + - *509 - *17 - *19 responses: @@ -73830,9 +73881,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *438 - *439 - - *508 + - *440 + - *509 responses: '201': description: Response @@ -73876,8 +73927,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -73899,7 +73950,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &511 + schema: &512 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -73981,7 +74032,7 @@ paths: type: - array - 'null' - items: *506 + items: *507 app: anyOf: - type: 'null' @@ -73997,7 +74048,7 @@ paths: - string - 'null' format: date-time - head_commit: *510 + head_commit: *511 latest_check_runs_count: type: integer check_runs_url: @@ -74025,7 +74076,7 @@ paths: - check_runs_url - pull_requests examples: - default: &512 + default: &513 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -74316,9 +74367,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *511 + schema: *512 examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74337,8 +74388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -74647,9 +74698,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *438 - *439 - - &513 + - *440 + - &514 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -74661,9 +74712,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *512 examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74686,17 +74737,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *438 - *439 - - *513 - - &558 + - *440 + - *514 + - &559 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &559 + - &560 name: status description: Returns check runs with the specified `status`. in: query @@ -74735,9 +74786,9 @@ paths: type: integer check_runs: type: array - items: *507 + items: *508 examples: - default: &560 + default: &561 value: total_count: 1 check_runs: @@ -74839,9 +74890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *438 - *439 - - *513 + - *440 + - *514 responses: '201': description: Response @@ -74874,21 +74925,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *438 - *439 + - *440 - *296 - *297 - *19 - *17 - - &529 + - &530 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *514 - - &530 + schema: *515 + - &531 name: pr description: The number of the pull request for the results you want to list. in: query @@ -74919,7 +74970,7 @@ paths: be returned. in: query required: false - schema: *515 + schema: *516 responses: '200': description: Response @@ -74935,7 +74986,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *516 + instances_url: *517 state: *107 fixed_at: *129 dismissed_by: @@ -74943,11 +74994,11 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *517 - dismissed_comment: *518 - rule: *519 - tool: *520 - most_recent_instance: *521 + dismissed_reason: *518 + dismissed_comment: *519 + rule: *520 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -75070,7 +75121,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &522 + '403': &523 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -75097,9 +75148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *438 - *439 - - &523 + - *440 + - &524 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -75113,7 +75164,7 @@ paths: description: Response content: application/json: - schema: &524 + schema: &525 type: object properties: number: *119 @@ -75121,7 +75172,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *516 + instances_url: *517 state: *107 fixed_at: *129 dismissed_by: @@ -75129,8 +75180,8 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *517 - dismissed_comment: *518 + dismissed_reason: *518 + dismissed_comment: *519 rule: type: object properties: @@ -75192,8 +75243,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *520 - most_recent_instance: *521 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -75289,7 +75340,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75309,9 +75360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 requestBody: required: true content: @@ -75326,8 +75377,8 @@ paths: enum: - open - dismissed - dismissed_reason: *517 - dismissed_comment: *518 + dismissed_reason: *518 + dismissed_comment: *519 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -75346,7 +75397,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *525 examples: default: value: @@ -75422,7 +75473,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &528 + '403': &529 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -75449,15 +75500,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 responses: '200': description: Response content: application/json: - schema: &525 + schema: &526 type: object properties: status: @@ -75484,13 +75535,13 @@ paths: - description - started_at examples: - default: &526 + default: &527 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &527 + '400': &528 description: Bad Request content: application/json: @@ -75501,7 +75552,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75526,29 +75577,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 responses: '200': description: OK content: application/json: - schema: *525 + schema: *526 examples: - default: *526 + default: *527 '202': description: Accepted content: application/json: - schema: *525 + schema: *526 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *527 + '400': *528 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -75580,9 +75631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 requestBody: required: false content: @@ -75628,8 +75679,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *527 - '403': *528 + '400': *528 + '403': *529 '404': *6 '422': description: Unprocessable Entity @@ -75653,13 +75704,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 - *19 - *17 - - *529 - *530 + - *531 responses: '200': description: Response @@ -75667,7 +75718,7 @@ paths: application/json: schema: type: array - items: *521 + items: *522 examples: default: value: @@ -75706,7 +75757,7 @@ paths: end_column: 50 classifications: - source - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75740,25 +75791,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *438 - *439 + - *440 - *296 - *297 - *19 - *17 - - *530 + - *531 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *514 + schema: *515 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &533 + schema: &534 type: string description: An identifier for the upload. examples: @@ -75780,23 +75831,23 @@ paths: application/json: schema: type: array - items: &534 + items: &535 type: object properties: - ref: *514 - commit_sha: &542 + ref: *515 + commit_sha: &543 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *531 + analysis_key: *532 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *532 + category: *533 error: type: string examples: @@ -75821,8 +75872,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *533 - tool: *520 + sarif_id: *534 + tool: *521 deletable: type: boolean warning: @@ -75884,7 +75935,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75920,8 +75971,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *438 - *439 + - *440 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75934,7 +75985,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *535 examples: response: summary: application/json response @@ -75988,7 +76039,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *522 + '403': *523 '404': *6 '422': description: Response if analysis could not be processed @@ -76075,8 +76126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *438 - *439 + - *440 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -76132,7 +76183,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *528 + '403': *529 '404': *6 '503': *184 x-github: @@ -76154,8 +76205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -76163,7 +76214,7 @@ paths: application/json: schema: type: array - items: &535 + items: &536 title: CodeQL Database description: A CodeQL database. type: object @@ -76275,7 +76326,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -76304,8 +76355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *438 - *439 + - *440 - name: language in: path description: The language of the CodeQL database. @@ -76317,7 +76368,7 @@ paths: description: Response content: application/json: - schema: *535 + schema: *536 examples: default: value: @@ -76349,9 +76400,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &565 + '302': &566 description: Found - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -76373,8 +76424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *438 - *439 + - *440 - name: language in: path description: The language of the CodeQL database. @@ -76384,7 +76435,7 @@ paths: responses: '204': description: Response - '403': *528 + '403': *529 '404': *6 '503': *184 x-github: @@ -76412,8 +76463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -76422,7 +76473,7 @@ paths: type: object additionalProperties: false properties: - language: &536 + language: &537 type: string description: The language targeted by the CodeQL query enum: @@ -76502,7 +76553,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &540 + schema: &541 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -76512,7 +76563,7 @@ paths: description: The ID of the variant analysis. controller_repo: *113 actor: *4 - query_language: *536 + query_language: *537 query_pack_url: type: string description: The download url for the query pack. @@ -76560,7 +76611,7 @@ paths: items: type: object properties: - repository: &537 + repository: &538 title: Repository Identifier description: Repository Identifier type: object @@ -76602,7 +76653,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &541 + analysis_status: &542 type: string description: The new status of the CodeQL variant analysis repository task. @@ -76634,7 +76685,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &538 + access_mismatch_repos: &539 type: object properties: repository_count: @@ -76649,7 +76700,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *537 + items: *538 required: - repository_count - repositories @@ -76672,8 +76723,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *538 - over_limit_repos: *538 + no_codeql_db_repos: *539 + over_limit_repos: *539 required: - access_mismatch_repos - not_found_repos @@ -76689,7 +76740,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &539 + value: &540 summary: Default response value: id: 1 @@ -76841,10 +76892,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *539 + value: *540 repository_lists: summary: Response for a successful variant analysis submission - value: *539 + value: *540 '404': *6 '422': description: Unable to process variant analysis submission @@ -76872,8 +76923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *438 - *439 + - *440 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -76885,9 +76936,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *541 examples: - default: *539 + default: *540 '404': *6 '503': *184 x-github: @@ -76910,7 +76961,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *438 + - *439 - name: repo in: path description: The name of the controller repository. @@ -76945,7 +76996,7 @@ paths: type: object properties: repository: *113 - analysis_status: *541 + analysis_status: *542 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -77070,8 +77121,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -77164,7 +77215,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -77185,8 +77236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -77280,7 +77331,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *528 + '403': *529 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -77351,8 +77402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -77360,7 +77411,7 @@ paths: schema: type: object properties: - commit_sha: *542 + commit_sha: *543 ref: type: string description: |- @@ -77420,7 +77471,7 @@ paths: schema: type: object properties: - id: *533 + id: *534 url: type: string description: The REST API URL for checking the status of the upload. @@ -77434,7 +77485,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *528 + '403': *529 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -77457,8 +77508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *438 - *439 + - *440 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -77506,7 +77557,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *522 + '403': *523 '404': description: Not Found if the sarif id does not match any upload '503': *184 @@ -77531,8 +77582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -77613,8 +77664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *438 - *439 + - *440 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -77742,8 +77793,8 @@ paths: parameters: - *17 - *19 - - *438 - *439 + - *440 responses: '200': description: Response @@ -78057,8 +78108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -78124,7 +78175,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -78132,7 +78183,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '400': *14 '401': *23 '403': *27 @@ -78161,8 +78212,8 @@ paths: parameters: - *17 - *19 - - *438 - *439 + - *440 responses: '200': description: Response @@ -78226,8 +78277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *438 - *439 + - *440 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -78264,9 +78315,9 @@ paths: type: integer machines: type: array - items: *544 + items: *545 examples: - default: &782 + default: &783 value: total_count: 2 machines: @@ -78306,8 +78357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *438 - *439 + - *440 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -78394,8 +78445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *438 - *439 + - *440 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -78464,8 +78515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -78483,7 +78534,7 @@ paths: type: integer secrets: type: array - items: &548 + items: &549 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -78504,7 +78555,7 @@ paths: - created_at - updated_at examples: - default: *545 + default: *546 headers: Link: *41 x-github: @@ -78527,16 +78578,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *546 + schema: *547 examples: - default: *547 + default: *548 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78556,17 +78607,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '200': description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *549 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78586,8 +78637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 requestBody: required: true @@ -78640,8 +78691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '204': @@ -78670,8 +78721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *438 - *439 + - *440 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -78709,7 +78760,7 @@ paths: application/json: schema: type: array - items: &550 + items: &551 title: Collaborator description: Collaborator type: object @@ -78902,8 +78953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *438 - *439 + - *440 - *132 responses: '204': @@ -78950,8 +79001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *438 - *439 + - *440 - *132 requestBody: required: false @@ -78978,7 +79029,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &623 + schema: &624 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -79206,8 +79257,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *438 - *439 + - *440 - *132 responses: '204': @@ -79239,8 +79290,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *438 - *439 + - *440 - *132 responses: '200': @@ -79261,7 +79312,7 @@ paths: user: anyOf: - type: 'null' - - *550 + - *551 required: - permission - role_name @@ -79315,8 +79366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -79326,7 +79377,7 @@ paths: application/json: schema: type: array - items: &551 + items: &552 title: Commit Comment description: Commit Comment type: object @@ -79384,7 +79435,7 @@ paths: - created_at - updated_at examples: - default: &554 + default: &555 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79443,17 +79494,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 responses: '200': description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: &555 + default: &556 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79510,8 +79561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -79534,7 +79585,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *552 examples: default: value: @@ -79585,8 +79636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 responses: '204': @@ -79608,8 +79659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -79636,9 +79687,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -79659,8 +79710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -79693,16 +79744,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -79724,10 +79775,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *438 - *439 + - *440 - *218 - - *430 + - *431 responses: '204': description: Response @@ -79776,8 +79827,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *438 - *439 + - *440 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -79833,9 +79884,9 @@ paths: application/json: schema: type: array - items: *552 + items: *553 examples: - default: &673 + default: &674 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -79929,9 +79980,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *438 - *439 - - &553 + - *440 + - &554 name: commit_sha description: The SHA of the commit. in: path @@ -80003,9 +80054,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *438 - *439 - - *553 + - *440 + - *554 - *17 - *19 responses: @@ -80015,9 +80066,9 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: - default: *554 + default: *555 headers: Link: *41 x-github: @@ -80045,9 +80096,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *438 - *439 - - *553 + - *440 + - *554 requestBody: required: true content: @@ -80082,9 +80133,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: *555 + default: *556 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80112,9 +80163,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *438 - *439 - - *553 + - *440 + - *554 - *17 - *19 responses: @@ -80124,9 +80175,9 @@ paths: application/json: schema: type: array - items: *556 + items: *557 examples: - default: &665 + default: &666 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -80663,11 +80714,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *438 - *439 + - *440 - *19 - *17 - - &557 + - &558 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -80682,9 +80733,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *553 examples: - default: &651 + default: &652 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -80797,11 +80848,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *438 - *439 - - *557 + - *440 - *558 - *559 + - *560 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -80835,9 +80886,9 @@ paths: type: integer check_runs: type: array - items: *507 + items: *508 examples: - default: *560 + default: *561 headers: Link: *41 x-github: @@ -80862,9 +80913,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *438 - *439 - - *557 + - *440 + - *558 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -80872,7 +80923,7 @@ paths: schema: type: integer example: 1 - - *558 + - *559 - *17 - *19 responses: @@ -80890,7 +80941,7 @@ paths: type: integer check_suites: type: array - items: *511 + items: *512 examples: default: value: @@ -81090,9 +81141,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *438 - *439 - - *557 + - *440 + - *558 - *17 - *19 responses: @@ -81294,9 +81345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *438 - *439 - - *557 + - *440 + - *558 - *17 - *19 responses: @@ -81306,7 +81357,7 @@ paths: application/json: schema: type: array - items: &727 + items: &728 title: Status description: The status of a commit. type: object @@ -81387,7 +81438,7 @@ paths: site_admin: false headers: Link: *41 - '301': *450 + '301': *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81415,8 +81466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -81449,11 +81500,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *561 + - *562 code_of_conduct_file: anyOf: - type: 'null' - - &562 + - &563 title: Community Health File type: object properties: @@ -81473,19 +81524,19 @@ paths: contributing: anyOf: - type: 'null' - - *562 + - *563 readme: anyOf: - type: 'null' - - *562 + - *563 issue_template: anyOf: - type: 'null' - - *562 + - *563 pull_request_template: anyOf: - type: 'null' - - *562 + - *563 required: - code_of_conduct - code_of_conduct_file @@ -81614,8 +81665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *438 - *439 + - *440 - *19 - *17 - name: basehead @@ -81663,8 +81714,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *552 - merge_base_commit: *552 + base_commit: *553 + merge_base_commit: *553 status: type: string enum: @@ -81688,10 +81739,10 @@ paths: - 6 commits: type: array - items: *552 + items: *553 files: type: array - items: *563 + items: *564 required: - url - html_url @@ -81977,8 +82028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *438 - *439 + - *440 - name: path description: path parameter in: path @@ -82131,7 +82182,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &564 + response-if-content-is-a-file: &565 summary: Response if content is a file value: type: file @@ -82268,7 +82319,7 @@ paths: - size - type - url - - &678 + - &679 title: Content File description: Content File type: object @@ -82486,7 +82537,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *564 + response-if-content-is-a-file: *565 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -82555,7 +82606,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *565 + '302': *566 '304': *35 x-github: githubCloudOnly: false @@ -82578,8 +82629,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *438 - *439 + - *440 - name: path description: path parameter in: path @@ -82674,7 +82725,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &567 title: File Commit description: File Commit type: object @@ -82830,7 +82881,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: example-for-creating-a-file: value: @@ -82884,7 +82935,7 @@ paths: schema: oneOf: - *3 - - &605 + - &606 description: Repository rule violation was detected type: object properties: @@ -82905,7 +82956,7 @@ paths: items: type: object properties: - placeholder_id: &719 + placeholder_id: &720 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -82937,8 +82988,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *438 - *439 + - *440 - name: path description: path parameter in: path @@ -82999,7 +83050,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -83054,8 +83105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *438 - *439 + - *440 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -83179,8 +83230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *438 - *439 + - *440 - *312 - *313 - *314 @@ -83192,7 +83243,7 @@ paths: schema: type: string - *316 - - *567 + - *568 - *317 - *318 - *104 @@ -83213,7 +83264,7 @@ paths: application/json: schema: type: array - items: &570 + items: &571 type: object description: A Dependabot alert. properties: @@ -83263,7 +83314,7 @@ paths: - direct - transitive - - security_advisory: *568 + security_advisory: *569 security_vulnerability: *123 url: *124 html_url: *125 @@ -83294,7 +83345,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: *569 + auto_dismissed_at: *570 required: - number - state @@ -83524,9 +83575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *438 - *439 - - &571 + - *440 + - &572 name: alert_number in: path description: |- @@ -83541,7 +83592,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *571 examples: default: value: @@ -83654,9 +83705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *438 - *439 - - *571 + - *440 + - *572 requestBody: required: true content: @@ -83701,7 +83752,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *571 examples: default: value: @@ -83830,8 +83881,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -83849,7 +83900,7 @@ paths: type: integer secrets: type: array - items: &574 + items: &575 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -83903,16 +83954,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *572 + schema: *573 examples: - default: *573 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83932,15 +83983,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '200': description: Response content: application/json: - schema: *574 + schema: *575 examples: default: value: @@ -83966,8 +84017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 requestBody: required: true @@ -84020,8 +84071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '204': @@ -84044,8 +84095,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *438 - *439 + - *440 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -84219,8 +84270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -84480,8 +84531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -84564,7 +84615,7 @@ paths: - version - url additionalProperties: false - metadata: &575 + metadata: &576 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -84603,7 +84654,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *575 + metadata: *576 resolved: type: object description: A collection of resolved package dependencies. @@ -84617,7 +84668,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *575 + metadata: *576 relationship: type: string description: A notation of whether a dependency is requested @@ -84750,8 +84801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *438 - *439 + - *440 - name: sha description: The SHA recorded at creation time. in: query @@ -84792,9 +84843,9 @@ paths: application/json: schema: type: array - items: *576 + items: *577 examples: - default: *577 + default: *578 headers: Link: *41 x-github: @@ -84860,8 +84911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -84943,7 +84994,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: simple-example: summary: Simple example @@ -85016,9 +85067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *438 - *439 - - &578 + - *440 + - &579 name: deployment_id description: deployment_id parameter in: path @@ -85030,7 +85081,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -85095,9 +85146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *438 - *439 - - *578 + - *440 + - *579 responses: '204': description: Response @@ -85119,9 +85170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *438 - *439 - - *578 + - *440 + - *579 - *17 - *19 responses: @@ -85131,7 +85182,7 @@ paths: application/json: schema: type: array - items: &579 + items: &580 title: Deployment Status description: The status of a deployment. type: object @@ -85295,9 +85346,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *438 - *439 - - *578 + - *440 + - *579 requestBody: required: true content: @@ -85372,9 +85423,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &580 + default: &581 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -85430,9 +85481,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *438 - *439 - - *578 + - *440 + - *579 - name: status_id in: path required: true @@ -85443,9 +85494,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *580 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -85472,12 +85523,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 - - *581 + - *440 - *582 - *583 - *584 + - *585 - *17 - *19 responses: @@ -85487,9 +85538,9 @@ paths: application/json: schema: type: array - items: *585 + items: *586 examples: - default: *586 + default: *587 '404': *6 '403': *27 '500': *38 @@ -85513,8 +85564,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85526,7 +85577,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *585 + schema: *586 examples: default: value: @@ -85582,8 +85633,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85642,12 +85693,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - *97 - *98 - *99 - - *587 + - *588 - *17 - *19 responses: @@ -85657,9 +85708,9 @@ paths: application/json: schema: type: array - items: *588 + items: *589 examples: - default: *589 + default: *590 '404': *6 '403': *27 '500': *38 @@ -85684,8 +85735,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85697,7 +85748,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *588 + schema: *589 examples: default: value: @@ -85755,8 +85806,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85825,8 +85876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -85883,8 +85934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -85902,7 +85953,7 @@ paths: - 5 environments: type: array - items: &591 + items: &592 title: Environment description: Details of a deployment environment type: object @@ -85964,7 +86015,7 @@ paths: type: string examples: - wait_timer - wait_timer: &593 + wait_timer: &594 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -86006,7 +86057,7 @@ paths: items: type: object properties: - type: *590 + type: *591 reviewer: anyOf: - *4 @@ -86033,7 +86084,7 @@ paths: - id - node_id - type - deployment_branch_policy: &594 + deployment_branch_policy: &595 type: - object - 'null' @@ -86150,9 +86201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *438 - *439 - - &592 + - *440 + - &593 name: environment_name in: path required: true @@ -86165,9 +86216,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: &595 + default: &596 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -86251,9 +86302,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *438 - *439 - - *592 + - *440 + - *593 requestBody: required: false content: @@ -86263,7 +86314,7 @@ paths: - object - 'null' properties: - wait_timer: *593 + wait_timer: *594 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -86282,14 +86333,14 @@ paths: items: type: object properties: - type: *590 + type: *591 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *594 + deployment_branch_policy: *595 additionalProperties: false examples: default: @@ -86309,9 +86360,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: *595 + default: *596 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -86335,9 +86386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *438 - *439 - - *592 + - *440 + - *593 responses: '204': description: Default response @@ -86362,9 +86413,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *17 - *19 responses: @@ -86383,7 +86434,7 @@ paths: - 2 branch_policies: type: array - items: &596 + items: &597 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -86444,9 +86495,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 + - *440 + - *593 requestBody: required: true content: @@ -86494,9 +86545,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - example-wildcard: &597 + example-wildcard: &598 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -86538,10 +86589,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 - - &598 + - *440 + - *593 + - &599 name: branch_policy_id in: path required: true @@ -86553,9 +86604,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86574,10 +86625,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 - - *598 + - *440 + - *593 + - *599 requestBody: required: true content: @@ -86606,9 +86657,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86627,10 +86678,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 - - *598 + - *440 + - *593 + - *599 responses: '204': description: Response @@ -86655,9 +86706,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 responses: '200': description: List of deployment protection rules @@ -86674,7 +86725,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &599 + items: &600 title: Deployment protection rule description: Deployment protection rule type: object @@ -86696,7 +86747,7 @@ paths: for the environment. examples: - true - app: &600 + app: &601 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -86799,9 +86850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 requestBody: content: application/json: @@ -86822,9 +86873,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *599 + schema: *600 examples: - default: &601 + default: &602 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -86859,9 +86910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 - *19 - *17 responses: @@ -86881,7 +86932,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *600 + items: *601 examples: default: value: @@ -86916,10 +86967,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *438 - *439 - - *592 - - &602 + - *440 + - *593 + - &603 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -86931,9 +86982,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *601 + default: *602 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86954,10 +87005,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 - - *602 + - *603 responses: '204': description: Response @@ -86983,9 +87034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *17 - *19 responses: @@ -87003,9 +87054,9 @@ paths: type: integer secrets: type: array - items: *473 + items: *474 examples: - default: *474 + default: *475 headers: Link: *41 x-github: @@ -87030,17 +87081,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *438 - *439 - - *592 + - *440 + - *593 responses: '200': description: Response content: application/json: - schema: *475 + schema: *476 examples: - default: *476 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87062,18 +87113,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *273 responses: '200': description: Response content: application/json: - schema: *473 + schema: *474 examples: - default: *603 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87095,9 +87146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *273 requestBody: required: true @@ -87155,9 +87206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *273 responses: '204': @@ -87183,10 +87234,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *438 - *439 - - *592 - - *460 + - *440 + - *593 + - *461 - *19 responses: '200': @@ -87203,9 +87254,9 @@ paths: type: integer variables: type: array - items: *477 + items: *478 examples: - default: *478 + default: *479 headers: Link: *41 x-github: @@ -87228,9 +87279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *438 - *439 - - *592 + - *440 + - *593 requestBody: required: true content: @@ -87282,18 +87333,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *276 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: *604 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87314,10 +87365,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *438 - *439 + - *440 - *276 - - *592 + - *593 requestBody: required: true content: @@ -87359,10 +87410,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *438 - *439 + - *440 - *276 - - *592 + - *593 responses: '204': description: Response @@ -87384,8 +87435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -87453,8 +87504,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *438 - *439 + - *440 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -87613,8 +87664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -87647,9 +87698,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 '400': *14 '422': *15 '403': *27 @@ -87670,8 +87721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -87731,7 +87782,7 @@ paths: schema: oneOf: - *238 - - *605 + - *606 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87756,8 +87807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *438 - *439 + - *440 - name: file_sha in: path required: true @@ -87857,8 +87908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -87967,7 +88018,7 @@ paths: description: Response content: application/json: - schema: &606 + schema: &607 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -88194,15 +88245,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *438 - *439 - - *553 + - *440 + - *554 responses: '200': description: Response content: application/json: - schema: *606 + schema: *607 examples: default: value: @@ -88258,9 +88309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *438 - *439 - - &607 + - *440 + - &608 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -88277,7 +88328,7 @@ paths: application/json: schema: type: array - items: &608 + items: &609 title: Git Reference description: Git references within a repository type: object @@ -88353,17 +88404,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *438 - *439 - - *607 + - *440 + - *608 responses: '200': description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: &609 + default: &610 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -88392,8 +88443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -88422,9 +88473,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -88450,9 +88501,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *438 - *439 - - *607 + - *440 + - *608 requestBody: required: true content: @@ -88481,9 +88532,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 '422': *15 '409': *112 x-github: @@ -88501,9 +88552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *438 - *439 - - *607 + - *440 + - *608 responses: '204': description: Response @@ -88558,8 +88609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -88626,7 +88677,7 @@ paths: description: Response content: application/json: - schema: &611 + schema: &612 title: Git Tag description: Metadata for a Git tag type: object @@ -88682,7 +88733,7 @@ paths: - sha - type - url - verification: *610 + verification: *611 required: - sha - url @@ -88692,7 +88743,7 @@ paths: - tag - message examples: - default: &612 + default: &613 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -88765,8 +88816,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *438 - *439 + - *440 - name: tag_sha in: path required: true @@ -88777,9 +88828,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *612 + default: *613 '404': *6 '409': *112 x-github: @@ -88803,8 +88854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -88878,7 +88929,7 @@ paths: description: Response content: application/json: - schema: &613 + schema: &614 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -88980,8 +89031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *438 - *439 + - *440 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -89004,7 +89055,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *614 examples: default-response: summary: Default response @@ -89063,8 +89114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -89074,7 +89125,7 @@ paths: application/json: schema: type: array - items: &614 + items: &615 title: Webhook description: Webhooks for repositories. type: object @@ -89137,7 +89188,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &860 + last_response: &861 title: Hook Response type: object properties: @@ -89214,8 +89265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -89268,9 +89319,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: &615 + default: &616 value: type: Repository id: 12345678 @@ -89318,17 +89369,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '200': description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '404': *6 x-github: githubCloudOnly: false @@ -89348,8 +89399,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 requestBody: required: true @@ -89395,9 +89446,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '422': *15 '404': *6 x-github: @@ -89418,8 +89469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '204': @@ -89444,8 +89495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *438 - *439 + - *440 - *324 responses: '200': @@ -89473,8 +89524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *438 - *439 + - *440 - *324 requestBody: required: false @@ -89519,8 +89570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 - *17 - *325 @@ -89552,8 +89603,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 - *16 responses: @@ -89582,8 +89633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 - *16 responses: @@ -89607,8 +89658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '204': @@ -89634,8 +89685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '204': @@ -89659,8 +89710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response if immutable releases are enabled @@ -89708,8 +89759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *438 - *439 + - *440 responses: '204': *144 '409': *112 @@ -89729,8 +89780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *438 - *439 + - *440 responses: '204': *144 '409': *112 @@ -89787,14 +89838,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: &616 + schema: &617 title: Import description: A repository import from an external source. type: object @@ -89901,7 +89952,7 @@ paths: - html_url - authors_url examples: - default: &619 + default: &620 value: vcs: subversion use_lfs: true @@ -89917,7 +89968,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &617 + '503': &618 description: Unavailable due to service under maintenance. content: application/json: @@ -89946,8 +89997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -89995,7 +90046,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -90020,7 +90071,7 @@ paths: type: string '422': *15 '404': *6 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90048,8 +90099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -90101,7 +90152,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: example-1: summary: Example 1 @@ -90149,7 +90200,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90172,12 +90223,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *438 - *439 + - *440 responses: '204': description: Response - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90203,9 +90254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *438 - *439 - - &803 + - *440 + - &804 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -90219,7 +90270,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Porter Author description: Porter Author type: object @@ -90273,7 +90324,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90298,8 +90349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *438 - *439 + - *440 - name: author_id in: path required: true @@ -90329,7 +90380,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -90342,7 +90393,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90366,8 +90417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -90408,7 +90459,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90436,8 +90487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -90464,11 +90515,11 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: - default: *619 + default: *620 '422': *15 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90491,8 +90542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -90500,8 +90551,8 @@ paths: application/json: schema: *20 examples: - default: *620 - '301': *450 + default: *621 + '301': *451 '404': *6 x-github: githubCloudOnly: false @@ -90521,8 +90572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -90535,7 +90586,7 @@ paths: properties: {} additionalProperties: false examples: - default: &622 + default: &623 value: limit: collaborators_only origin: repository @@ -90560,13 +90611,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: application/json: - schema: *621 + schema: *622 examples: default: summary: Example request body @@ -90580,7 +90631,7 @@ paths: application/json: schema: *342 examples: - default: *622 + default: *623 '409': description: Response x-github: @@ -90602,8 +90653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -90626,8 +90677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -90637,9 +90688,9 @@ paths: application/json: schema: type: array - items: *623 + items: *624 examples: - default: &796 + default: &797 value: - id: 1 repository: @@ -90770,8 +90821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *438 - *439 + - *440 - *346 requestBody: required: false @@ -90801,7 +90852,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *624 examples: default: value: @@ -90932,8 +90983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *438 - *439 + - *440 - *346 responses: '204': @@ -90965,8 +91016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *438 - *439 + - *440 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -91039,7 +91090,7 @@ paths: type: array items: *219 examples: - default: &631 + default: &632 value: - id: 1 node_id: MDU6SXNzdWUx @@ -91187,7 +91238,7 @@ paths: state_reason: completed headers: Link: *41 - '301': *450 + '301': *451 '422': *15 '404': *6 x-github: @@ -91216,8 +91267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -91309,7 +91360,7 @@ paths: application/json: schema: *219 examples: - default: &628 + default: &629 value: id: 1 node_id: MDU6SXNzdWUx @@ -91465,7 +91516,7 @@ paths: '422': *15 '503': *184 '404': *6 - '410': *624 + '410': *625 x-github: triggersNotification: true githubCloudOnly: false @@ -91493,8 +91544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *438 - *439 + - *440 - *228 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -91515,9 +91566,9 @@ paths: application/json: schema: type: array - items: *625 + items: *626 examples: - default: &630 + default: &631 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91575,17 +91626,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 responses: '200': description: Response content: application/json: - schema: *625 + schema: *626 examples: - default: &626 + default: &627 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91639,8 +91690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -91663,9 +91714,9 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: - default: *626 + default: *627 '422': *15 x-github: githubCloudOnly: false @@ -91683,8 +91734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 responses: '204': @@ -91705,8 +91756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -91733,9 +91784,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -91756,8 +91807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -91790,16 +91841,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -91821,10 +91872,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *438 - *439 + - *440 - *218 - - *430 + - *431 responses: '204': description: Response @@ -91844,8 +91895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -91855,7 +91906,7 @@ paths: application/json: schema: type: array - items: &627 + items: &628 title: Issue Event description: Issue Event type: object @@ -92194,8 +92245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *438 - *439 + - *440 - name: event_id in: path required: true @@ -92206,7 +92257,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *628 examples: default: value: @@ -92399,7 +92450,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *624 + '410': *625 '403': *27 x-github: githubCloudOnly: false @@ -92433,9 +92484,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *438 - *439 - - &629 + - *440 + - &630 name: issue_number description: The number that identifies the issue. in: path @@ -92449,10 +92500,10 @@ paths: application/json: schema: *219 examples: - default: *628 - '301': *450 + default: *629 + '301': *451 '404': *6 - '410': *624 + '410': *625 '304': *35 x-github: githubCloudOnly: false @@ -92477,9 +92528,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -92600,13 +92651,13 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 '422': *15 '503': *184 '403': *27 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92624,9 +92675,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -92654,7 +92705,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92670,9 +92721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: content: application/json: @@ -92699,7 +92750,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92721,9 +92772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: assignee in: path required: true @@ -92763,9 +92814,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *209 - *17 - *19 @@ -92776,13 +92827,13 @@ paths: application/json: schema: type: array - items: *625 + items: *626 examples: - default: *630 + default: *631 headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92811,9 +92862,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -92835,16 +92886,16 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: - default: *626 + default: *627 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *624 + '410': *625 '422': *15 '404': *6 x-github: @@ -92872,9 +92923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -92886,12 +92937,12 @@ paths: type: array items: *219 examples: - default: *631 + default: *632 headers: Link: *41 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92919,9 +92970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -92945,15 +92996,15 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *450 + '301': *451 '403': *27 - '410': *624 + '410': *625 '422': *15 '404': *6 x-github: @@ -92984,9 +93035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -93000,13 +93051,13 @@ paths: application/json: schema: *219 examples: - default: *628 - '301': *450 + default: *629 + '301': *451 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *624 + '410': *625 x-github: triggersNotification: true githubCloudOnly: false @@ -93032,9 +93083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -93046,12 +93097,12 @@ paths: type: array items: *219 examples: - default: *631 + default: *632 headers: Link: *41 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93068,9 +93119,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -93084,7 +93135,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &634 + - &635 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -93133,7 +93184,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &635 + - &636 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -93261,7 +93312,7 @@ paths: - performed_via_github_app - assignee - assigner - - &636 + - &637 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -93307,7 +93358,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &637 + - &638 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -93353,7 +93404,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &638 + - &639 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -93402,7 +93453,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &639 + - &640 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -93444,7 +93495,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &640 + - &641 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -93486,7 +93537,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &641 + - &642 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -93542,7 +93593,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &642 + - &643 title: Locked Issue Event description: Locked Issue Event type: object @@ -93587,7 +93638,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &643 + - &644 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -93648,7 +93699,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &644 + - &645 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -93709,7 +93760,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &645 + - &646 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -93770,7 +93821,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &646 + - &647 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -93863,7 +93914,7 @@ paths: color: red headers: Link: *41 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93880,9 +93931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -93892,7 +93943,7 @@ paths: application/json: schema: type: array - items: &632 + items: &633 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -93947,7 +93998,7 @@ paths: - color - default examples: - default: &633 + default: &634 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93965,9 +94016,9 @@ paths: default: false headers: Link: *41 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93984,9 +94035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -94045,12 +94096,12 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 - '301': *450 + default: *634 + '301': *451 '404': *6 - '410': *624 + '410': *625 '422': *15 x-github: githubCloudOnly: false @@ -94067,9 +94118,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -94129,12 +94180,12 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 - '301': *450 + default: *634 + '301': *451 '404': *6 - '410': *624 + '410': *625 '422': *15 x-github: githubCloudOnly: false @@ -94151,15 +94202,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 responses: '204': description: Response - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94178,9 +94229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: name in: path required: true @@ -94193,7 +94244,7 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: default: value: @@ -94204,9 +94255,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94226,9 +94277,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -94257,7 +94308,7 @@ paths: '204': description: Response '403': *27 - '410': *624 + '410': *625 '404': *6 '422': *15 x-github: @@ -94275,9 +94326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 responses: '204': description: Response @@ -94307,9 +94358,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 responses: '200': description: Response @@ -94317,10 +94368,10 @@ paths: application/json: schema: *219 examples: - default: *628 - '301': *450 + default: *629 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94337,9 +94388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -94365,13 +94416,13 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94389,9 +94440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94423,16 +94474,16 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -94454,10 +94505,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *438 - *439 - - *629 - - *430 + - *440 + - *630 + - *431 responses: '204': description: Response @@ -94486,9 +94537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94512,7 +94563,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -94545,9 +94596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -94559,11 +94610,11 @@ paths: type: array items: *219 examples: - default: *631 + default: *632 headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94591,9 +94642,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94622,14 +94673,14 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *624 + '410': *625 '422': *15 '404': *6 x-github: @@ -94649,9 +94700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94684,7 +94735,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 '403': *27 '404': *6 '422': *7 @@ -94706,9 +94757,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -94723,7 +94774,6 @@ paths: description: Timeline Event type: object anyOf: - - *634 - *635 - *636 - *637 @@ -94736,6 +94786,7 @@ paths: - *644 - *645 - *646 + - *647 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -95064,7 +95115,7 @@ paths: type: string comments: type: array - items: &667 + items: &668 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -95302,7 +95353,7 @@ paths: type: string comments: type: array - items: *551 + items: *552 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -95577,7 +95628,7 @@ paths: headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95594,8 +95645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -95605,7 +95656,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -95673,8 +95724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -95710,9 +95761,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: &648 + default: &649 value: id: 1 key: ssh-rsa AAA... @@ -95746,9 +95797,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *438 - *439 - - &649 + - *440 + - &650 name: key_id description: The unique identifier of the key. in: path @@ -95760,9 +95811,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: *648 + default: *649 '404': *6 x-github: githubCloudOnly: false @@ -95780,9 +95831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *438 - *439 - - *649 + - *440 + - *650 responses: '204': description: Response @@ -95802,8 +95853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -95813,9 +95864,9 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 + default: *634 headers: Link: *41 '404': *6 @@ -95836,8 +95887,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -95873,9 +95924,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *633 examples: - default: &650 + default: &651 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -95907,8 +95958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *438 - *439 + - *440 - name: name in: path required: true @@ -95919,9 +95970,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *633 examples: - default: *650 + default: *651 '404': *6 x-github: githubCloudOnly: false @@ -95938,8 +95989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *438 - *439 + - *440 - name: name in: path required: true @@ -95978,7 +96029,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *633 examples: default: value: @@ -96004,8 +96055,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *438 - *439 + - *440 - name: name in: path required: true @@ -96031,8 +96082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -96068,8 +96119,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *438 - *439 + - *440 responses: '202': *37 '403': @@ -96097,8 +96148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -96124,9 +96175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *438 - *439 - - *529 + - *440 + - *530 responses: '200': description: Response @@ -96273,8 +96324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -96339,8 +96390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -96374,9 +96425,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *552 + schema: *553 examples: - default: *651 + default: *652 '204': description: Response when already merged '404': @@ -96401,8 +96452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *438 - *439 + - *440 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -96499,8 +96550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -96542,7 +96593,7 @@ paths: application/json: schema: *381 examples: - default: &652 + default: &653 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -96601,9 +96652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *438 - *439 - - &653 + - *440 + - &654 name: milestone_number description: The number that identifies the milestone. in: path @@ -96617,7 +96668,7 @@ paths: application/json: schema: *381 examples: - default: *652 + default: *653 '404': *6 x-github: githubCloudOnly: false @@ -96634,9 +96685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *438 - *439 - - *653 + - *440 + - *654 requestBody: required: false content: @@ -96676,7 +96727,7 @@ paths: application/json: schema: *381 examples: - default: *652 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96692,9 +96743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *438 - *439 - - *653 + - *440 + - *654 responses: '204': description: Response @@ -96715,9 +96766,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *438 - *439 - - *653 + - *440 + - *654 - *17 - *19 responses: @@ -96727,9 +96778,9 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 + default: *634 headers: Link: *41 x-github: @@ -96748,12 +96799,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *438 - *439 - - *654 + - *440 - *655 - - *209 - *656 + - *209 + - *657 - *17 - *19 responses: @@ -96765,7 +96816,7 @@ paths: type: array items: *231 examples: - default: *657 + default: *658 headers: Link: *41 x-github: @@ -96789,8 +96840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -96848,14 +96899,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: &658 + schema: &659 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -96999,7 +97050,7 @@ paths: - custom_404 - public examples: - default: &659 + default: &660 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -97040,8 +97091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -97096,9 +97147,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *659 examples: - default: *659 + default: *660 '422': *15 '409': *112 x-github: @@ -97121,8 +97172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -97230,8 +97281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -97257,8 +97308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -97268,7 +97319,7 @@ paths: application/json: schema: type: array - items: &660 + items: &661 title: Page Build description: Page Build type: object @@ -97360,8 +97411,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *438 - *439 + - *440 responses: '201': description: Response @@ -97408,16 +97459,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *660 + schema: *661 examples: - default: &661 + default: &662 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -97465,8 +97516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *438 - *439 + - *440 - name: build_id in: path required: true @@ -97477,9 +97528,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *661 examples: - default: *661 + default: *662 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97499,8 +97550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -97608,9 +97659,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *438 - *439 - - &662 + - *440 + - &663 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -97668,9 +97719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *438 - *439 - - *662 + - *440 + - *663 responses: '204': *144 '404': *6 @@ -97697,8 +97748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -97993,8 +98044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Private vulnerability reporting status @@ -98031,8 +98082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': *144 '422': *14 @@ -98053,8 +98104,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': *144 '422': *14 @@ -98076,8 +98127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -98087,7 +98138,7 @@ paths: type: array items: *145 examples: - default: *663 + default: *664 '403': *27 '404': *6 x-github: @@ -98109,8 +98160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -98126,7 +98177,7 @@ paths: required: - properties examples: - default: *664 + default: *665 responses: '204': description: No Content when custom property values are successfully created @@ -98164,8 +98215,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *438 - *439 + - *440 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -98225,9 +98276,9 @@ paths: application/json: schema: type: array - items: *556 + items: *557 examples: - default: *665 + default: *666 headers: Link: *41 '304': *35 @@ -98259,8 +98310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -98327,7 +98378,7 @@ paths: description: Response content: application/json: - schema: &669 + schema: &670 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -98567,7 +98618,7 @@ paths: - review_comment - self author_association: *206 - auto_merge: *666 + auto_merge: *667 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -98669,7 +98720,7 @@ paths: - merged_by - review_comments examples: - default: &670 + default: &671 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -99196,8 +99247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *438 - *439 + - *440 - name: sort in: query required: false @@ -99226,9 +99277,9 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: - default: &672 + default: &673 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99305,17 +99356,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *438 - *439 + - *440 - *218 responses: '200': description: Response content: application/json: - schema: *667 + schema: *668 examples: - default: &668 + default: &669 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99390,8 +99441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -99414,9 +99465,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: - default: *668 + default: *669 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99432,8 +99483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *438 - *439 + - *440 - *218 responses: '204': @@ -99455,8 +99506,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *438 - *439 + - *440 - *218 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -99483,9 +99534,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -99506,8 +99557,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -99540,16 +99591,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -99571,10 +99622,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *438 - *439 + - *440 - *218 - - *430 + - *431 responses: '204': description: Response @@ -99617,9 +99668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *438 - *439 - - &671 + - *440 + - &672 name: pull_number description: The number that identifies the pull request. in: path @@ -99632,9 +99683,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '304': *35 '404': *6 '406': @@ -99669,9 +99720,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -99713,9 +99764,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '422': *15 '403': *27 x-github: @@ -99737,9 +99788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: true content: @@ -99802,7 +99853,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -99810,7 +99861,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '401': *23 '403': *27 '404': *6 @@ -99840,9 +99891,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *228 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -99863,9 +99914,9 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: - default: *672 + default: *673 headers: Link: *41 x-github: @@ -99898,9 +99949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: true content: @@ -100006,7 +100057,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: example-for-a-multi-line-comment: value: @@ -100094,9 +100145,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *218 requestBody: required: true @@ -100119,7 +100170,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: default: value: @@ -100205,9 +100256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *17 - *19 responses: @@ -100217,9 +100268,9 @@ paths: application/json: schema: type: array - items: *552 + items: *553 examples: - default: *673 + default: *674 headers: Link: *41 x-github: @@ -100249,9 +100300,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *17 - *19 responses: @@ -100261,7 +100312,7 @@ paths: application/json: schema: type: array - items: *563 + items: *564 examples: default: value: @@ -100299,9 +100350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *438 - *439 - - *671 + - *440 + - *672 responses: '204': description: Response if pull request has been merged @@ -100324,9 +100375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -100438,9 +100489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 responses: '200': description: Response @@ -100515,9 +100566,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -100554,7 +100605,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *557 examples: default: value: @@ -101090,9 +101141,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: true content: @@ -101126,7 +101177,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *557 examples: default: value: @@ -101631,9 +101682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *17 - *19 responses: @@ -101643,7 +101694,7 @@ paths: application/json: schema: type: array - items: &674 + items: &675 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -101799,9 +101850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -101891,9 +101942,9 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: &676 + default: &677 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -101956,10 +102007,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - &675 + - *440 + - *672 + - &676 name: review_id description: The unique identifier of the review. in: path @@ -101971,9 +102022,9 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: &677 + default: &678 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -102032,10 +102083,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 requestBody: required: true content: @@ -102058,7 +102109,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -102120,18 +102171,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 responses: '200': description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: *676 + default: *677 '422': *7 '404': *6 x-github: @@ -102158,10 +102209,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 - *17 - *19 responses: @@ -102419,10 +102470,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 requestBody: required: true content: @@ -102451,7 +102502,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -102514,10 +102565,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 requestBody: required: true content: @@ -102552,9 +102603,9 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: *677 + default: *678 '404': *6 '422': *7 '403': *27 @@ -102576,9 +102627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -102642,8 +102693,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *438 - *439 + - *440 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -102656,9 +102707,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: &679 + default: &680 value: type: file encoding: base64 @@ -102700,8 +102751,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *438 - *439 + - *440 - name: dir description: The alternate path to look for a README file in: path @@ -102721,9 +102772,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: *679 + default: *680 '404': *6 '422': *15 x-github: @@ -102745,8 +102796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -102756,7 +102807,7 @@ paths: application/json: schema: type: array - items: &680 + items: &681 title: Release description: A release. type: object @@ -102838,7 +102889,7 @@ paths: author: *4 assets: type: array - items: &681 + items: &682 title: Release Asset description: Data related to a release. type: object @@ -103025,8 +103076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -103102,9 +103153,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -103209,9 +103260,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *438 - *439 - - &682 + - *440 + - &683 name: asset_id description: The unique identifier of the asset. in: path @@ -103223,9 +103274,9 @@ paths: description: Response content: application/json: - schema: *681 + schema: *682 examples: - default: &683 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -103260,7 +103311,7 @@ paths: type: User site_admin: false '404': *6 - '302': *565 + '302': *566 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103276,9 +103327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *438 - *439 - - *682 + - *440 + - *683 requestBody: required: false content: @@ -103307,9 +103358,9 @@ paths: description: Response content: application/json: - schema: *681 + schema: *682 examples: - default: *683 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103325,9 +103376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *438 - *439 - - *682 + - *440 + - *683 responses: '204': description: Response @@ -103351,8 +103402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -103438,16 +103489,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103464,8 +103515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *438 - *439 + - *440 - name: tag description: tag parameter in: path @@ -103478,9 +103529,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 '404': *6 x-github: githubCloudOnly: false @@ -103502,9 +103553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *438 - *439 - - &685 + - *440 + - &686 name: release_id description: The unique identifier of the release. in: path @@ -103518,9 +103569,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 '401': description: Unauthorized x-github: @@ -103538,9 +103589,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 requestBody: required: false content: @@ -103604,9 +103655,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 '404': description: Not Found if the discussion category name is invalid content: @@ -103627,9 +103678,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 responses: '204': description: Response @@ -103649,9 +103700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *438 - *439 - - *685 + - *440 + - *686 - *17 - *19 responses: @@ -103661,7 +103712,7 @@ paths: application/json: schema: type: array - items: *681 + items: *682 examples: default: value: @@ -103743,9 +103794,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *438 - *439 - - *685 + - *440 + - *686 - name: name in: query required: true @@ -103771,7 +103822,7 @@ paths: description: Response for successful upload content: application/json: - schema: *681 + schema: *682 examples: response-for-successful-upload: value: @@ -103826,9 +103877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -103852,9 +103903,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -103875,9 +103926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 requestBody: required: true content: @@ -103907,16 +103958,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -103938,10 +103989,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *438 - *439 - - *685 - - *430 + - *440 + - *686 + - *431 responses: '204': description: Response @@ -103965,9 +104016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 - *17 - *19 responses: @@ -103984,7 +104035,7 @@ paths: oneOf: - allOf: - *159 - - &686 + - &687 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -104005,67 +104056,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *160 - - *686 + - *687 - allOf: - *161 - - *686 + - *687 - allOf: - *162 - - *686 + - *687 - allOf: + - *688 - *687 - - *686 - allOf: - *163 - - *686 + - *687 - allOf: - *164 - - *686 + - *687 - allOf: - *165 - - *686 + - *687 - allOf: - *166 - - *686 + - *687 - allOf: - *167 - - *686 + - *687 - allOf: - *168 - - *686 + - *687 - allOf: - *169 - - *686 + - *687 - allOf: - *170 - - *686 + - *687 - allOf: - *171 - - *686 + - *687 - allOf: - *172 - - *686 + - *687 - allOf: - *173 - - *686 + - *687 - allOf: - *174 - - *686 + - *687 - allOf: - *175 - - *686 + - *687 - allOf: - *176 - - *686 + - *687 - allOf: - *177 - - *686 + - *687 - allOf: - *178 - - *686 + - *687 - allOf: - - *688 - - *686 + - *689 + - *687 examples: default: value: @@ -104104,8 +104155,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - *17 - *19 - name: includes_parents @@ -104116,7 +104167,7 @@ paths: schema: type: boolean default: true - - *689 + - *690 responses: '200': description: Response @@ -104171,8 +104222,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 requestBody: description: Request body required: true @@ -104201,7 +104252,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *690 + items: *691 required: - name - enforcement @@ -104234,7 +104285,7 @@ paths: application/json: schema: *179 examples: - default: &699 + default: &700 value: id: 42 name: super cool ruleset @@ -104281,12 +104332,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *438 - *439 - - *691 - - *99 + - *440 - *692 + - *99 - *693 + - *694 - *17 - *19 responses: @@ -104294,9 +104345,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *695 examples: - default: *695 + default: *696 '404': *6 '500': *38 x-github: @@ -104317,17 +104368,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *438 - *439 - - *696 + - *440 + - *697 responses: '200': description: Response content: application/json: - schema: *697 + schema: *698 examples: - default: *698 + default: *699 '404': *6 '500': *38 x-github: @@ -104355,8 +104406,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104378,7 +104429,7 @@ paths: application/json: schema: *179 examples: - default: *699 + default: *700 '404': *6 '500': *38 put: @@ -104396,8 +104447,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104431,7 +104482,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *690 + items: *691 examples: default: value: @@ -104461,7 +104512,7 @@ paths: application/json: schema: *179 examples: - default: *699 + default: *700 '404': *6 '500': *38 delete: @@ -104479,8 +104530,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104503,8 +104554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *438 - *439 + - *440 - *17 - *19 - name: ruleset_id @@ -104541,8 +104592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104615,21 +104666,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *438 - *439 + - *440 - *399 - *400 - *401 - *402 + - *403 - *104 - *19 - *17 - - *700 - *701 - - *403 + - *702 - *404 - *405 - *406 + - *407 responses: '200': description: Response @@ -104637,7 +104689,7 @@ paths: application/json: schema: type: array - items: &705 + items: &706 type: object properties: number: *119 @@ -104653,8 +104705,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *702 - resolution: *703 + state: *703 + resolution: *704 resolved_at: type: - string @@ -104748,7 +104800,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *704 + - *705 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -104893,16 +104945,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *438 - *439 - - *523 - - *406 + - *440 + - *524 + - *407 responses: '200': description: Response content: application/json: - schema: *705 + schema: *706 examples: default: value: @@ -104944,6 +104996,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -104954,9 +105008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 requestBody: required: true content: @@ -104964,28 +105018,44 @@ paths: schema: type: object properties: - state: *702 - resolution: *703 + state: *703 + resolution: *704 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: + - string + - 'null' anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *705 + schema: *706 examples: default: value: @@ -105030,6 +105100,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -105037,7 +105126,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *184 x-github: enabledForGitHubApps: true @@ -105060,9 +105150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 - *19 - *17 responses: @@ -105073,7 +105163,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &880 + items: &881 type: object properties: type: @@ -105100,7 +105190,6 @@ paths: - commit details: oneOf: - - *706 - *707 - *708 - *709 @@ -105113,6 +105202,7 @@ paths: - *716 - *717 - *718 + - *719 examples: default: value: @@ -105198,8 +105288,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -105207,14 +105297,14 @@ paths: schema: type: object properties: - reason: &720 + reason: &721 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *719 + placeholder_id: *720 required: - reason - placeholder_id @@ -105231,7 +105321,7 @@ paths: schema: type: object properties: - reason: *720 + reason: *721 expire_at: type: - string @@ -105278,8 +105368,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *438 - *439 + - *440 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -105294,7 +105384,7 @@ paths: properties: incremental_scans: type: array - items: &721 + items: &722 description: Information on a single scan performed by secret scanning on the repository type: object @@ -105322,15 +105412,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *721 + items: *722 backfill_scans: type: array - items: *721 + items: *722 custom_pattern_backfill_scans: type: array items: allOf: - - *721 + - *722 - type: object properties: pattern_name: @@ -105400,8 +105490,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *438 - *439 + - *440 - *104 - name: sort description: The property to sort the results by. @@ -105445,9 +105535,9 @@ paths: application/json: schema: type: array - items: *722 + items: *723 examples: - default: *723 + default: *724 '400': *14 '404': *6 x-github: @@ -105470,8 +105560,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -105551,7 +105641,7 @@ paths: login: type: string description: The username of the user credited. - type: *411 + type: *412 required: - login - type @@ -105641,9 +105731,9 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: - default: &725 + default: &726 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -105876,8 +105966,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -105990,7 +106080,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: default: value: @@ -106137,17 +106227,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *438 - *439 - - *724 + - *440 + - *725 responses: '200': description: Response content: application/json: - schema: *722 + schema: *723 examples: - default: *725 + default: *726 '403': *27 '404': *6 x-github: @@ -106171,9 +106261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *438 - *439 - - *724 + - *440 + - *725 requestBody: required: true content: @@ -106253,7 +106343,7 @@ paths: login: type: string description: The username of the user credited. - type: *411 + type: *412 required: - login - type @@ -106344,10 +106434,10 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: - default: *725 - add_credit: *725 + default: *726 + add_credit: *726 '403': *27 '404': *6 '422': @@ -106385,9 +106475,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *438 - *439 - - *724 + - *440 + - *725 responses: '202': *37 '400': *14 @@ -106414,17 +106504,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *438 - *439 - - *724 + - *440 + - *725 responses: '202': description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 '400': *14 '422': *15 '403': *27 @@ -106450,8 +106540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -106547,8 +106637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *438 - *439 + - *440 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -106557,7 +106647,7 @@ paths: application/json: schema: type: array - items: &726 + items: &727 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106590,8 +106680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -106669,8 +106759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -106764,8 +106854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *438 - *439 + - *440 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -106919,8 +107009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *438 - *439 + - *440 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -106930,7 +107020,7 @@ paths: application/json: schema: type: array - items: *726 + items: *727 examples: default: value: @@ -106963,8 +107053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *438 - *439 + - *440 - name: sha in: path required: true @@ -107020,7 +107110,7 @@ paths: description: Response content: application/json: - schema: *727 + schema: *728 examples: default: value: @@ -107074,8 +107164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -107107,14 +107197,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *438 - *439 + - *440 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &728 + schema: &729 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -107187,8 +107277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -107214,7 +107304,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -107241,8 +107331,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -107262,8 +107352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -107345,8 +107435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -107354,7 +107444,7 @@ paths: application/json: schema: type: array - items: &729 + items: &730 title: Tag protection description: Tag protection type: object @@ -107411,8 +107501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -107435,7 +107525,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *730 examples: default: value: @@ -107466,8 +107556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *438 - *439 + - *440 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -107504,8 +107594,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *438 - *439 + - *440 - name: ref in: path required: true @@ -107541,8 +107631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -107574,8 +107664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *438 - *439 + - *440 - *19 - *17 responses: @@ -107583,7 +107673,7 @@ paths: description: Response content: application/json: - schema: &730 + schema: &731 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -107595,7 +107685,7 @@ paths: required: - names examples: - default: &731 + default: &732 value: names: - octocat @@ -107618,8 +107708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -107650,9 +107740,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *731 examples: - default: *731 + default: *732 '404': *6 '422': *7 x-github: @@ -107673,9 +107763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *438 - *439 - - &732 + - *440 + - &733 name: per description: The time frame to display results for. in: query @@ -107706,7 +107796,7 @@ paths: - 128 clones: type: array - items: &733 + items: &734 title: Traffic type: object properties: @@ -107793,8 +107883,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -107888,8 +107978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -107952,9 +108042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *438 - *439 - - *732 + - *440 + - *733 responses: '200': description: Response @@ -107975,7 +108065,7 @@ paths: - 3782 views: type: array - items: *733 + items: *734 required: - uniques - count @@ -108052,8 +108142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -108327,8 +108417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -108351,8 +108441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -108374,8 +108464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -108401,8 +108491,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *438 - *439 + - *440 - name: ref in: path required: true @@ -108494,9 +108584,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -108647,7 +108737,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &741 + - &742 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -108657,7 +108747,7 @@ paths: type: string examples: - members - - &746 + - &747 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -108669,7 +108759,7 @@ paths: format: int32 examples: - 1 - - &747 + - &748 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -108713,7 +108803,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &736 + items: &737 allOf: - type: object required: @@ -108795,7 +108885,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &748 + meta: &749 type: object description: The metadata associated with the creation/updates to the user. @@ -108860,30 +108950,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &737 + '400': &738 description: Bad request content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '401': *735 - '403': &738 + schema: *735 + '401': *736 + '403': &739 description: Permission denied - '429': &739 + '429': &740 description: Too many requests content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '500': &740 + schema: *735 + '500': &741 description: Internal server error content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 + schema: *735 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108907,7 +108997,7 @@ paths: required: true content: application/json: - schema: &744 + schema: &745 type: object required: - schemas @@ -108971,9 +109061,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *736 + schema: *737 examples: - group: &742 + group: &743 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -108992,13 +109082,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *737 - '401': *735 - '403': *738 - '409': &745 + '400': *738 + '401': *736 + '403': *739 + '409': &746 description: Duplicate record detected - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109015,7 +109105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &743 + - &744 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -109024,22 +109114,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *741 + - *742 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *736 + schema: *737 examples: - default: *742 - '400': *737 - '401': *735 - '403': *738 + default: *743 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109058,13 +109148,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *743 + - *744 - *39 requestBody: required: true content: application/json: - schema: *744 + schema: *745 examples: group: summary: Group @@ -109090,17 +109180,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *736 + schema: *737 examples: - group: *742 - groupWithMembers: *742 - '400': *737 - '401': *735 - '403': *738 + group: *743 + groupWithMembers: *743 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109124,13 +109214,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *743 + - *744 - *39 requestBody: required: true content: application/json: - schema: &755 + schema: &756 type: object required: - Operations @@ -109190,17 +109280,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *736 + schema: *737 examples: - updateGroup: *742 - addMembers: *742 - '400': *737 - '401': *735 - '403': *738 + updateGroup: *743 + addMembers: *743 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109216,17 +109306,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *743 + - *744 - *39 responses: '204': description: Group was deleted, no content - '400': *737 - '401': *735 - '403': *738 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109260,8 +109350,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *746 - *747 + - *748 - *39 responses: '200': @@ -109295,7 +109385,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &750 + items: &751 allOf: - type: object required: @@ -109387,7 +109477,7 @@ paths: address. examples: - true - roles: &749 + roles: &750 type: array description: The roles assigned to the user. items: @@ -109446,7 +109536,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *748 + meta: *749 startIndex: type: integer description: A starting index for the returned page @@ -109485,11 +109575,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *737 - '401': *735 - '403': *738 - '429': *739 - '500': *740 + '400': *738 + '401': *736 + '403': *739 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109513,7 +109603,7 @@ paths: required: true content: application/json: - schema: &753 + schema: &754 type: object required: - schemas @@ -109606,9 +109696,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *749 + roles: *750 examples: - user: &754 + user: &755 summary: User value: schemas: @@ -109655,9 +109745,9 @@ paths: description: User has been created content: application/scim+json: - schema: *750 + schema: *751 examples: - user: &751 + user: &752 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -109683,13 +109773,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *751 - '400': *737 - '401': *735 - '403': *738 - '409': *745 - '429': *739 - '500': *740 + enterpriseOwner: *752 + '400': *738 + '401': *736 + '403': *739 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109706,7 +109796,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &752 + - &753 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -109719,15 +109809,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *750 + schema: *751 examples: - default: *751 - '400': *737 - '401': *735 - '403': *738 + default: *752 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109749,30 +109839,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *752 + - *753 - *39 requestBody: required: true content: application/json: - schema: *753 + schema: *754 examples: - user: *754 + user: *755 responses: '200': description: User was updated content: application/scim+json: - schema: *750 + schema: *751 examples: - user: *751 - '400': *737 - '401': *735 - '403': *738 + user: *752 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109807,13 +109897,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *752 + - *753 - *39 requestBody: required: true content: application/json: - schema: *755 + schema: *756 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -109853,18 +109943,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *750 + schema: *751 examples: - userMultiValuedProperties: *751 - userSingleValuedProperties: *751 - disableUser: *751 - '400': *737 - '401': *735 - '403': *738 + userMultiValuedProperties: *752 + userSingleValuedProperties: *752 + disableUser: *752 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109884,17 +109974,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *752 + - *753 - *39 responses: '204': description: User was deleted, no content - '400': *737 - '401': *735 - '403': *738 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109985,7 +110075,7 @@ paths: - 1 Resources: type: array - items: &756 + items: &757 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -110232,22 +110322,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &757 + '404': &758 description: Resource not found content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '403': &758 + schema: *735 + '403': &759 description: Forbidden content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '400': *737 - '429': *739 + schema: *735 + '400': *738 + '429': *740 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -110273,9 +110363,9 @@ paths: description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: &759 + default: &760 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -110298,17 +110388,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *757 - '403': *758 - '500': *740 + '404': *758 + '403': *759 + '500': *741 '409': description: Conflict content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '400': *737 + schema: *735 + '400': *738 requestBody: required: true content: @@ -110408,17 +110498,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *81 - - *752 + - *753 responses: '200': description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: *759 - '404': *757 - '403': *758 + default: *760 + '404': *758 + '403': *759 '304': *35 x-github: githubCloudOnly: true @@ -110442,18 +110532,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *81 - - *752 + - *753 responses: '200': description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: *759 + default: *760 '304': *35 - '404': *757 - '403': *758 + '404': *758 + '403': *759 requestBody: required: true content: @@ -110568,19 +110658,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *81 - - *752 + - *753 responses: '200': description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: *759 + default: *760 '304': *35 - '404': *757 - '403': *758 - '400': *737 + '404': *758 + '403': *759 + '400': *738 '429': description: Response content: @@ -110676,12 +110766,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *81 - - *752 + - *753 responses: '204': description: Response - '404': *757 - '403': *758 + '404': *758 + '403': *759 '304': *35 x-github: githubCloudOnly: true @@ -110815,7 +110905,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &760 + text_matches: &761 title: Search Result Text Matches type: array items: @@ -110979,7 +111069,7 @@ paths: enum: - author-date - committer-date - - &761 + - &762 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -111048,7 +111138,7 @@ paths: committer: anyOf: - type: 'null' - - *493 + - *494 comment_count: type: integer message: @@ -111067,7 +111157,7 @@ paths: url: type: string format: uri - verification: *610 + verification: *611 required: - author - committer @@ -111082,7 +111172,7 @@ paths: committer: anyOf: - type: 'null' - - *493 + - *494 parents: type: array items: @@ -111099,7 +111189,7 @@ paths: type: number node_id: type: string - text_matches: *760 + text_matches: *761 required: - sha - node_id @@ -111292,7 +111382,7 @@ paths: - interactions - created - updated - - *761 + - *762 - *17 - *19 - name: advanced_search @@ -111389,11 +111479,11 @@ paths: type: - string - 'null' - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: type: string state_reason: @@ -111421,7 +111511,7 @@ paths: - string - 'null' format: date-time - text_matches: *760 + text_matches: *761 pull_request: type: object properties: @@ -111644,7 +111734,7 @@ paths: enum: - created - updated - - *761 + - *762 - *17 - *19 responses: @@ -111689,7 +111779,7 @@ paths: - 'null' score: type: number - text_matches: *760 + text_matches: *761 required: - id - node_id @@ -111775,7 +111865,7 @@ paths: - forks - help-wanted-issues - updated - - *761 + - *762 - *17 - *19 responses: @@ -112012,7 +112102,7 @@ paths: - admin - pull - push - text_matches: *760 + text_matches: *761 temp_clone_token: type: string allow_merge_commit: @@ -112321,7 +112411,7 @@ paths: - string - 'null' format: uri - text_matches: *760 + text_matches: *761 related: type: - array @@ -112516,7 +112606,7 @@ paths: - followers - repositories - joined - - *761 + - *762 - *17 - *19 responses: @@ -112626,7 +112716,7 @@ paths: type: - boolean - 'null' - text_matches: *760 + text_matches: *761 blog: type: - string @@ -112708,7 +112798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &765 + - &766 name: team_id description: The unique identifier of the team. in: path @@ -112720,9 +112810,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 x-github: githubCloudOnly: false @@ -112749,7 +112839,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *765 + - *766 requestBody: required: true content: @@ -112813,16 +112903,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '201': description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 '422': *15 '403': *27 @@ -112850,7 +112940,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *765 + - *766 responses: '204': description: Response @@ -112881,7 +112971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *765 + - *766 - *104 - *17 - *19 @@ -112892,9 +112982,9 @@ paths: application/json: schema: type: array - items: *421 + items: *422 examples: - default: *766 + default: *767 headers: Link: *41 x-github: @@ -112923,7 +113013,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *765 + - *766 requestBody: required: true content: @@ -112957,9 +113047,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *422 + default: *423 x-github: triggersNotification: true githubCloudOnly: false @@ -112986,16 +113076,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 responses: '200': description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *422 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113020,8 +113110,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 requestBody: required: false content: @@ -113044,9 +113134,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *767 + default: *768 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113071,8 +113161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 responses: '204': description: Response @@ -113101,8 +113191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *765 - - *423 + - *766 + - *424 - *104 - *17 - *19 @@ -113113,9 +113203,9 @@ paths: application/json: schema: type: array - items: *424 + items: *425 examples: - default: *768 + default: *769 headers: Link: *41 x-github: @@ -113144,8 +113234,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *765 - - *423 + - *766 + - *424 requestBody: required: true content: @@ -113167,9 +113257,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *425 + default: *426 x-github: triggersNotification: true githubCloudOnly: false @@ -113196,17 +113286,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 responses: '200': description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *425 + default: *426 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113231,9 +113321,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 requestBody: required: true content: @@ -113255,9 +113345,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *769 + default: *770 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113282,9 +113372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 responses: '204': description: Response @@ -113313,9 +113403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -113341,9 +113431,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 x-github: @@ -113372,9 +113462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 requestBody: required: true content: @@ -113406,9 +113496,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113434,8 +113524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -113461,9 +113551,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 x-github: @@ -113492,8 +113582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 requestBody: required: true content: @@ -113525,9 +113615,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113551,7 +113641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -113589,7 +113679,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *765 + - *766 - name: role description: Filters members returned by their role in the team. in: query @@ -113640,7 +113730,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113677,7 +113767,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113717,7 +113807,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113754,16 +113844,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *765 + - *766 - *132 responses: '200': description: Response content: application/json: - schema: *435 + schema: *436 examples: - response-if-user-is-a-team-maintainer: *770 + response-if-user-is-a-team-maintainer: *771 '404': *6 x-github: githubCloudOnly: false @@ -113796,7 +113886,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *765 + - *766 - *132 requestBody: required: false @@ -113822,9 +113912,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *436 examples: - response-if-users-membership-with-team-is-now-pending: *771 + response-if-users-membership-with-team-is-now-pending: *772 '403': description: Forbidden if team synchronization is set up '422': @@ -113858,7 +113948,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113887,7 +113977,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -113897,9 +113987,9 @@ paths: application/json: schema: type: array - items: *436 + items: *437 examples: - default: *772 + default: *773 headers: Link: *41 '404': *6 @@ -113925,16 +114015,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *765 - - *437 + - *766 + - *438 responses: '200': description: Response content: application/json: - schema: *436 + schema: *437 examples: - default: *773 + default: *774 '404': description: Not Found if project is not managed by this team x-github: @@ -113958,8 +114048,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *765 - - *437 + - *766 + - *438 requestBody: required: false content: @@ -114026,8 +114116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *765 - - *437 + - *766 + - *438 responses: '204': description: Response @@ -114054,7 +114144,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -114096,15 +114186,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *765 - - *438 + - *766 - *439 + - *440 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *774 + schema: *775 examples: alternative-response-with-extra-repository-information: value: @@ -114255,9 +114345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *765 - - *438 + - *766 - *439 + - *440 requestBody: required: false content: @@ -114307,9 +114397,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *765 - - *438 + - *766 - *439 + - *440 responses: '204': description: Response @@ -114338,15 +114428,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *765 + - *766 responses: '200': description: Response content: application/json: - schema: *440 + schema: *441 examples: - default: *441 + default: *442 '403': *27 '404': *6 x-github: @@ -114373,7 +114463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *765 + - *766 requestBody: required: true content: @@ -114434,7 +114524,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *441 examples: default: value: @@ -114465,7 +114555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -114477,7 +114567,7 @@ paths: type: array items: *292 examples: - response-if-child-teams-exist: *775 + response-if-child-teams-exist: *776 headers: Link: *41 '404': *6 @@ -114510,7 +114600,7 @@ paths: application/json: schema: oneOf: - - &777 + - &778 title: Private User description: Private User type: object @@ -114760,7 +114850,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *776 + - *777 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -114920,7 +115010,7 @@ paths: description: Response content: application/json: - schema: *777 + schema: *778 examples: default: value: @@ -115266,7 +115356,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -115274,7 +115364,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '401': *23 '403': *27 '404': *6 @@ -115318,7 +115408,7 @@ paths: type: integer secrets: type: array - items: &778 + items: &779 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -115360,7 +115450,7 @@ paths: - visibility - selected_repositories_url examples: - default: *545 + default: *546 headers: Link: *41 x-github: @@ -115438,7 +115528,7 @@ paths: description: Response content: application/json: - schema: *778 + schema: *779 examples: default: value: @@ -115584,7 +115674,7 @@ paths: type: array items: *263 examples: - default: *779 + default: *780 '401': *23 '403': *27 '404': *6 @@ -115736,7 +115826,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '304': *35 '500': *38 '401': *23 @@ -115794,7 +115884,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '401': *23 '403': *27 '404': *6 @@ -115851,7 +115941,7 @@ paths: description: Response content: application/json: - schema: &780 + schema: &781 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -115904,7 +115994,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &781 + default: &782 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -115949,9 +116039,9 @@ paths: description: Response content: application/json: - schema: *780 + schema: *781 examples: - default: *781 + default: *782 '404': *6 x-github: githubCloudOnly: false @@ -115988,9 +116078,9 @@ paths: type: integer machines: type: array - items: *544 + items: *545 examples: - default: *782 + default: *783 '304': *35 '500': *38 '401': *23 @@ -116075,11 +116165,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *449 + repository: *450 machine: anyOf: - type: 'null' - - *544 + - *545 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -116884,7 +116974,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '304': *35 '500': *38 '400': *14 @@ -116924,7 +117014,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '500': *38 '401': *23 '403': *27 @@ -116956,7 +117046,7 @@ paths: type: array items: *362 examples: - default: &793 + default: &794 value: - id: 197 name: hello_docker @@ -117057,7 +117147,7 @@ paths: application/json: schema: type: array - items: &783 + items: &784 title: Email description: Email type: object @@ -117127,9 +117217,9 @@ paths: application/json: schema: type: array - items: *783 + items: *784 examples: - default: &795 + default: &796 value: - email: octocat@github.com verified: true @@ -117206,7 +117296,7 @@ paths: application/json: schema: type: array - items: *783 + items: *784 examples: default: value: @@ -117464,7 +117554,7 @@ paths: application/json: schema: type: array - items: &784 + items: &785 title: GPG Key description: A unique encryption key type: object @@ -117609,7 +117699,7 @@ paths: - subkeys - revoked examples: - default: &809 + default: &810 value: - id: 3 name: Octocat's GPG Key @@ -117694,9 +117784,9 @@ paths: description: Response content: application/json: - schema: *784 + schema: *785 examples: - default: &785 + default: &786 value: id: 3 name: Octocat's GPG Key @@ -117753,7 +117843,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &786 + - &787 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -117765,9 +117855,9 @@ paths: description: Response content: application/json: - schema: *784 + schema: *785 examples: - default: *785 + default: *786 '404': *6 '304': *35 '403': *27 @@ -117790,7 +117880,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *786 + - *787 responses: '204': description: Response @@ -118095,7 +118185,7 @@ paths: required: true content: application/json: - schema: *621 + schema: *622 examples: default: value: @@ -118245,7 +118335,7 @@ paths: application/json: schema: type: array - items: &787 + items: &788 title: Key description: Key type: object @@ -118348,9 +118438,9 @@ paths: description: Response content: application/json: - schema: *787 + schema: *788 examples: - default: &788 + default: &789 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118383,15 +118473,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *649 + - *650 responses: '200': description: Response content: application/json: - schema: *787 + schema: *788 examples: - default: *788 + default: *789 '404': *6 '304': *35 '403': *27 @@ -118414,7 +118504,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *649 + - *650 responses: '204': description: Response @@ -118447,7 +118537,7 @@ paths: application/json: schema: type: array - items: &789 + items: &790 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -118526,7 +118616,7 @@ paths: - account - plan examples: - default: &790 + default: &791 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -118588,9 +118678,9 @@ paths: application/json: schema: type: array - items: *789 + items: *790 examples: - default: *790 + default: *791 headers: Link: *41 '304': *35 @@ -119594,7 +119684,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *358 - - *791 + - *792 responses: '204': description: Response @@ -119709,7 +119799,7 @@ paths: - docker - nuget - container - - *792 + - *793 - *19 - *17 responses: @@ -119721,8 +119811,8 @@ paths: type: array items: *362 examples: - default: *793 - '400': *794 + default: *794 + '400': *795 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119751,7 +119841,7 @@ paths: application/json: schema: *362 examples: - default: &810 + default: &811 value: id: 40201 name: octo-name @@ -120113,9 +120203,9 @@ paths: application/json: schema: type: array - items: *783 + items: *784 examples: - default: *795 + default: *796 headers: Link: *41 '304': *35 @@ -120228,7 +120318,7 @@ paths: type: array items: *72 examples: - default: &802 + default: &803 summary: Default response value: - id: 1296269 @@ -120546,9 +120636,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -120586,9 +120676,9 @@ paths: application/json: schema: type: array - items: *623 + items: *624 examples: - default: *796 + default: *797 headers: Link: *41 '304': *35 @@ -120667,7 +120757,7 @@ paths: application/json: schema: type: array - items: &797 + items: &798 title: Social account description: Social media account type: object @@ -120684,7 +120774,7 @@ paths: - provider - url examples: - default: &798 + default: &799 value: - provider: twitter url: https://twitter.com/github @@ -120747,9 +120837,9 @@ paths: application/json: schema: type: array - items: *797 + items: *798 examples: - default: *798 + default: *799 '422': *15 '304': *35 '404': *6 @@ -120837,7 +120927,7 @@ paths: application/json: schema: type: array - items: &799 + items: &800 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -120857,7 +120947,7 @@ paths: - title - created_at examples: - default: &814 + default: &815 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -120922,9 +121012,9 @@ paths: description: Response content: application/json: - schema: *799 + schema: *800 examples: - default: &800 + default: &801 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -120954,7 +121044,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &801 + - &802 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -120966,9 +121056,9 @@ paths: description: Response content: application/json: - schema: *799 + schema: *800 examples: - default: *800 + default: *801 '404': *6 '304': *35 '403': *27 @@ -120991,7 +121081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *801 + - *802 responses: '204': description: Response @@ -121020,7 +121110,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &815 + - &816 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -121045,11 +121135,11 @@ paths: type: array items: *72 examples: - default-response: *802 + default-response: *803 application/vnd.github.v3.star+json: schema: type: array - items: &816 + items: &817 title: Starred Repository description: Starred Repository type: object @@ -121205,8 +121295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *438 - *439 + - *440 responses: '204': description: Response if this repository is starred by you @@ -121234,8 +121324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -121259,8 +121349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -121332,7 +121422,7 @@ paths: application/json: schema: type: array - items: *419 + items: *420 examples: default: value: @@ -121418,10 +121508,10 @@ paths: application/json: schema: oneOf: + - *778 - *777 - - *776 examples: - default-response: &804 + default-response: &805 summary: Default response value: login: octocat @@ -121456,7 +121546,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &805 + response-with-git-hub-plan-information: &806 summary: Response with GitHub plan information value: login: octocat @@ -121578,7 +121668,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *803 + - *804 - *17 responses: '200': @@ -121627,11 +121717,11 @@ paths: application/json: schema: oneOf: + - *778 - *777 - - *776 examples: - default-response: *804 - response-with-git-hub-plan-information: *805 + default-response: *805 + response-with-git-hub-plan-information: *806 '404': *6 x-github: githubCloudOnly: false @@ -121681,8 +121771,8 @@ paths: required: - subject_digests examples: - default: *806 - withPredicateType: *807 + default: *807 + withPredicateType: *808 responses: '200': description: Response @@ -121736,7 +121826,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *808 + default: *809 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121941,7 +122031,7 @@ paths: initiator: type: string examples: - default: *489 + default: *490 '201': description: Response content: @@ -121982,7 +122072,7 @@ paths: type: array items: *362 examples: - default: *793 + default: *794 '403': *27 '401': *23 x-github: @@ -122366,9 +122456,9 @@ paths: application/json: schema: type: array - items: *784 + items: *785 examples: - default: *809 + default: *810 headers: Link: *41 x-github: @@ -122472,7 +122562,7 @@ paths: application/json: schema: *20 examples: - default: *620 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122597,7 +122687,7 @@ paths: - docker - nuget - container - - *792 + - *793 - *132 - *19 - *17 @@ -122610,10 +122700,10 @@ paths: type: array items: *362 examples: - default: *793 + default: *794 '403': *27 '401': *23 - '400': *794 + '400': *795 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122643,7 +122733,7 @@ paths: application/json: schema: *362 examples: - default: *810 + default: *811 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122992,7 +123082,7 @@ paths: type: array items: *383 examples: - default: *811 + default: *812 headers: Link: *41 '304': *35 @@ -123003,6 +123093,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - *132 + - *380 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *383 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *35 + '403': *27 + '401': *23 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -123015,7 +123356,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - *380 - - *812 + - *813 - *132 responses: '200': @@ -123024,7 +123365,7 @@ paths: application/json: schema: *383 examples: - default: *813 + default: *814 headers: Link: *41 '304': *35 @@ -123562,9 +123903,9 @@ paths: application/json: schema: type: array - items: *797 + items: *798 examples: - default: *798 + default: *799 headers: Link: *41 x-github: @@ -123594,9 +123935,9 @@ paths: application/json: schema: type: array - items: *799 + items: *800 examples: - default: *814 + default: *815 headers: Link: *41 x-github: @@ -123621,7 +123962,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *132 - - *815 + - *816 - *104 - *17 - *19 @@ -123633,11 +123974,11 @@ paths: schema: anyOf: - type: array - items: *816 + items: *817 - type: array items: *72 examples: - default-response: *802 + default-response: *803 headers: Link: *41 x-github: @@ -123797,7 +124138,7 @@ webhooks: type: string enum: - disabled - enterprise: &817 + enterprise: &818 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -123866,7 +124207,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &818 + installation: &819 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -123887,7 +124228,7 @@ webhooks: required: - id - node_id - organization: &819 + organization: &820 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -123960,7 +124301,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &820 + repository: &821 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -124873,10 +125214,10 @@ webhooks: type: string enum: - enabled - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -124952,11 +125293,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - rule: &821 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + rule: &822 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -125179,11 +125520,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - rule: *821 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + rule: *822 sender: *4 required: - action @@ -125371,11 +125712,11 @@ webhooks: - everyone required: - from - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - rule: *821 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + rule: *822 sender: *4 required: - action @@ -125448,7 +125789,7 @@ webhooks: required: true content: application/json: - schema: &841 + schema: &842 title: Exemption request cancellation event type: object properties: @@ -125456,11 +125797,11 @@ webhooks: type: string enum: - cancelled - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: &822 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: &823 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -125698,7 +126039,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &823 + items: &824 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -125810,7 +126151,7 @@ webhooks: required: true content: application/json: - schema: &842 + schema: &843 title: Exemption request completed event type: object properties: @@ -125818,11 +126159,11 @@ webhooks: type: string enum: - completed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 sender: *4 required: - action @@ -125894,7 +126235,7 @@ webhooks: required: true content: application/json: - schema: &839 + schema: &840 title: Exemption request created event type: object properties: @@ -125902,11 +126243,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 sender: *4 required: - action @@ -125978,7 +126319,7 @@ webhooks: required: true content: application/json: - schema: &843 + schema: &844 title: Exemption response dismissed event type: object properties: @@ -125986,12 +126327,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 - exemption_response: *823 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 + exemption_response: *824 sender: *4 required: - action @@ -126065,7 +126406,7 @@ webhooks: required: true content: application/json: - schema: &840 + schema: &841 title: Exemption response submitted event type: object properties: @@ -126073,12 +126414,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 - exemption_response: *823 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 + exemption_response: *824 sender: *4 required: - action @@ -126162,7 +126503,7 @@ webhooks: type: string enum: - completed - check_run: &825 + check_run: &826 title: CheckRun description: A check performed on the code of a given code change type: object @@ -126227,7 +126568,7 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *506 + items: *507 repository: *263 status: type: string @@ -126272,7 +126613,7 @@ webhooks: - examples: - neutral - deployment: *824 + deployment: *825 details_url: type: string examples: @@ -126332,7 +126673,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *506 + items: *507 started_at: type: string format: date-time @@ -126370,10 +126711,10 @@ webhooks: - output - app - pull_requests - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 sender: *4 required: - check_run @@ -126766,11 +127107,11 @@ webhooks: type: string enum: - created - check_run: *825 - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + check_run: *826 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 sender: *4 required: - check_run @@ -127166,11 +127507,11 @@ webhooks: type: string enum: - requested_action - check_run: *825 - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + check_run: *826 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 requested_action: description: The action requested by the user. type: object @@ -127575,11 +127916,11 @@ webhooks: type: string enum: - rerequested - check_run: *825 - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + check_run: *826 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 sender: *4 required: - check_run @@ -128571,10 +128912,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -128855,6 +129196,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -129274,10 +129620,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -129553,6 +129899,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -129971,10 +130322,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -130143,7 +130494,7 @@ webhooks: required: - login - id - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130295,20 +130646,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &826 + commit_oid: &827 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *817 - installation: *818 - organization: *819 - ref: &827 + enterprise: *818 + installation: *819 + organization: *820 + ref: &828 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *820 + repository: *821 sender: *4 required: - action @@ -130475,7 +130826,7 @@ webhooks: required: - login - id - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130716,12 +131067,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -130819,7 +131170,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131004,12 +131355,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -131178,7 +131529,7 @@ webhooks: required: - login - id - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131355,12 +131706,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -131463,7 +131814,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131643,9 +131994,9 @@ webhooks: type: - string - 'null' - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -131653,7 +132004,7 @@ webhooks: type: - string - 'null' - repository: *820 + repository: *821 sender: *4 required: - action @@ -131752,7 +132103,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131899,12 +132250,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -132166,10 +132517,10 @@ webhooks: - updated_at - author_association - body - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -132250,18 +132601,18 @@ webhooks: type: - string - 'null' - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *819 - pusher_type: &828 + organization: *820 + pusher_type: &829 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &829 + ref: &830 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -132271,7 +132622,7 @@ webhooks: enum: - tag - branch - repository: *820 + repository: *821 sender: *4 required: - ref @@ -132354,9 +132705,9 @@ webhooks: enum: - created definition: *146 - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132441,9 +132792,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132521,9 +132872,9 @@ webhooks: enum: - promote_to_enterprise definition: *146 - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132601,9 +132952,9 @@ webhooks: enum: - updated definition: *146 - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132680,10 +133031,10 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - repository: *820 - organization: *819 + enterprise: *818 + installation: *819 + repository: *821 + organization: *820 sender: *4 new_property_values: type: array @@ -132768,18 +133119,18 @@ webhooks: title: delete event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - pusher_type: *828 - ref: *829 + enterprise: *818 + installation: *819 + organization: *820 + pusher_type: *829 + ref: *830 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *820 + repository: *821 sender: *4 required: - ref @@ -132863,11 +133214,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -132951,11 +133302,11 @@ webhooks: type: string enum: - auto_reopened - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133039,11 +133390,11 @@ webhooks: type: string enum: - created - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133125,11 +133476,11 @@ webhooks: type: string enum: - dismissed - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133211,11 +133562,11 @@ webhooks: type: string enum: - fixed - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133298,11 +133649,11 @@ webhooks: type: string enum: - reintroduced - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133384,11 +133735,11 @@ webhooks: type: string enum: - reopened - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133465,9 +133816,9 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - key: &830 + enterprise: *818 + installation: *819 + key: &831 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -133505,8 +133856,8 @@ webhooks: - verified - created_at - read_only - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -133583,11 +133934,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - key: *830 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + key: *831 + organization: *820 + repository: *821 sender: *4 required: - action @@ -134159,12 +134510,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: &834 + workflow: &835 title: Workflow type: - object @@ -134902,13 +135253,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *576 + deployment: *577 pull_requests: type: array - items: *669 - repository: *820 - organization: *819 - installation: *818 + items: *670 + repository: *821 + organization: *820 + installation: *819 sender: *4 responses: '200': @@ -134979,7 +135330,7 @@ webhooks: type: string enum: - approved - approver: &831 + approver: &832 type: object properties: avatar_url: @@ -135022,11 +135373,11 @@ webhooks: type: string comment: type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - reviewers: &832 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + reviewers: &833 type: array items: type: object @@ -135107,7 +135458,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &833 + workflow_job_run: &834 type: object properties: conclusion: @@ -135853,18 +136204,18 @@ webhooks: type: string enum: - rejected - approver: *831 + approver: *832 comment: type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - reviewers: *832 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + reviewers: *833 sender: *4 since: type: string - workflow_job_run: *833 + workflow_job_run: *834 workflow_job_runs: type: array items: @@ -136581,13 +136932,13 @@ webhooks: type: string enum: - requested - enterprise: *817 + enterprise: *818 environment: type: string - installation: *818 - organization: *819 - repository: *820 - requestor: &844 + installation: *819 + organization: *820 + repository: *821 + requestor: &845 title: User type: - object @@ -138530,12 +138881,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Deployment Workflow Run type: @@ -139226,7 +139577,7 @@ webhooks: type: string enum: - answered - answer: &837 + answer: &838 type: object properties: author_association: @@ -139386,7 +139737,7 @@ webhooks: - created_at - updated_at - body - discussion: &835 + discussion: &836 title: Discussion description: A Discussion in a repository. type: object @@ -139682,7 +140033,7 @@ webhooks: - id labels: type: array - items: *632 + items: *633 required: - repository_url - category @@ -139704,10 +140055,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -139834,11 +140185,11 @@ webhooks: - from required: - category - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -139921,11 +140272,11 @@ webhooks: type: string enum: - closed - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140007,7 +140358,7 @@ webhooks: type: string enum: - created - comment: &836 + comment: &837 type: object properties: author_association: @@ -140167,11 +140518,11 @@ webhooks: - updated_at - body - reactions - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140254,12 +140605,12 @@ webhooks: type: string enum: - deleted - comment: *836 - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + comment: *837 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140354,12 +140705,12 @@ webhooks: - from required: - body - comment: *836 - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + comment: *837 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140443,11 +140794,11 @@ webhooks: type: string enum: - created - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140529,11 +140880,11 @@ webhooks: type: string enum: - deleted - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140633,11 +140984,11 @@ webhooks: type: string required: - from - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140719,10 +141070,10 @@ webhooks: type: string enum: - labeled - discussion: *835 - enterprise: *817 - installation: *818 - label: &838 + discussion: *836 + enterprise: *818 + installation: *819 + label: &839 title: Label type: object properties: @@ -140755,8 +141106,8 @@ webhooks: - color - default - description - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140839,11 +141190,11 @@ webhooks: type: string enum: - locked - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140925,11 +141276,11 @@ webhooks: type: string enum: - pinned - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141011,11 +141362,11 @@ webhooks: type: string enum: - reopened - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141100,16 +141451,16 @@ webhooks: changes: type: object properties: - new_discussion: *835 - new_repository: *820 + new_discussion: *836 + new_repository: *821 required: - new_discussion - new_repository - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141192,10 +141543,10 @@ webhooks: type: string enum: - unanswered - discussion: *835 - old_answer: *837 - organization: *819 - repository: *820 + discussion: *836 + old_answer: *838 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141277,12 +141628,12 @@ webhooks: type: string enum: - unlabeled - discussion: *835 - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141365,11 +141716,11 @@ webhooks: type: string enum: - unlocked - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141451,11 +141802,11 @@ webhooks: type: string enum: - unpinned - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141524,7 +141875,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141587,7 +141938,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141653,7 +142004,7 @@ webhooks: required: true content: application/json: - schema: *841 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141719,7 +142070,7 @@ webhooks: required: true content: application/json: - schema: *842 + schema: *843 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141785,7 +142136,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141851,7 +142202,7 @@ webhooks: required: true content: application/json: - schema: *843 + schema: *844 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141917,7 +142268,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141943,71 +142294,6 @@ webhooks: externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset 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: *841 - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: true - category: webhooks - subcategory: exemption_request_push_ruleset - supported-webhook-types: - - repository - - organization - - app - exemption-request-push-ruleset-completed: - post: - summary: |- - This event occurs when there is activity related to a user's request to bypass a set of push rules. - - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: A push ruleset bypass request was completed. - operationId: exemption-request-push-ruleset/completed - externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset - parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc @@ -142060,6 +142346,71 @@ webhooks: - repository - organization - app + exemption-request-push-ruleset-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A push ruleset bypass request was completed. + operationId: exemption-request-push-ruleset/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + 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: *843 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: exemption_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app exemption-request-push-ruleset-created: post: summary: |- @@ -142112,7 +142463,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142177,7 +142528,7 @@ webhooks: required: true content: application/json: - schema: *843 + schema: *844 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142243,7 +142594,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142310,7 +142661,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *817 + enterprise: *818 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -142988,9 +143339,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - forkee @@ -143136,9 +143487,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pages: description: The pages that were updated. type: array @@ -143176,7 +143527,7 @@ webhooks: - action - sha - html_url - repository: *820 + repository: *821 sender: *4 required: - pages @@ -143252,10 +143603,10 @@ webhooks: type: string enum: - created - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: &845 + organization: *820 + repositories: &846 description: An array of repository objects that the installation can access. type: array @@ -143281,8 +143632,8 @@ webhooks: - name - full_name - private - repository: *820 - requester: *844 + repository: *821 + requester: *845 sender: *4 required: - action @@ -143357,11 +143708,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -143438,11 +143789,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -143519,10 +143870,10 @@ webhooks: type: string enum: - added - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories_added: &846 + organization: *820 + repositories_added: &847 description: An array of repository objects, which were added to the installation. type: array @@ -143568,15 +143919,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *820 - repository_selection: &847 + repository: *821 + repository_selection: &848 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *844 + requester: *845 sender: *4 required: - action @@ -143655,10 +144006,10 @@ webhooks: type: string enum: - removed - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories_added: *846 + organization: *820 + repositories_added: *847 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -143685,9 +144036,9 @@ webhooks: - name - full_name - private - repository: *820 - repository_selection: *847 - requester: *844 + repository: *821 + repository_selection: *848 + requester: *845 sender: *4 required: - action @@ -143766,11 +144117,11 @@ webhooks: type: string enum: - suspend - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -143953,10 +144304,10 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 target_type: type: string @@ -144035,11 +144386,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -144287,8 +144638,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -145105,8 +145456,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145467,8 +145818,8 @@ webhooks: - state - locked - assignee - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -145548,7 +145899,7 @@ webhooks: type: string enum: - deleted - comment: &848 + comment: &849 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -145715,8 +146066,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -146529,8 +146880,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146893,8 +147244,8 @@ webhooks: - state - locked - assignee - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -146974,7 +147325,7 @@ webhooks: type: string enum: - edited - changes: &872 + changes: &873 description: The changes to the comment. type: object properties: @@ -146986,9 +147337,9 @@ webhooks: type: string required: - from - comment: *848 - enterprise: *817 - installation: *818 + comment: *849 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -147804,8 +148155,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148166,8 +148517,8 @@ webhooks: - state - locked - assignee - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148257,9 +148608,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *72 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148353,9 +148704,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *72 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148448,9 +148799,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148544,9 +148895,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148631,10 +148982,10 @@ webhooks: type: string enum: - assigned - assignee: *844 - enterprise: *817 - installation: *818 - issue: &851 + assignee: *845 + enterprise: *818 + installation: *819 + issue: &852 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -149446,11 +149797,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149570,8 +149921,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -149651,8 +150002,8 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -150469,11 +150820,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150736,8 +151087,8 @@ webhooks: required: - state - closed_at - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -150816,8 +151167,8 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151625,11 +151976,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151748,8 +152099,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -151828,8 +152179,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152660,11 +153011,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152762,7 +153113,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &849 + milestone: &850 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152905,8 +153256,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -153005,8 +153356,8 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153818,11 +154169,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153942,9 +154293,9 @@ webhooks: - active_lock_reason - body - reactions - label: *838 - organization: *819 - repository: *820 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -154024,8 +154375,8 @@ webhooks: type: string enum: - labeled - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154836,11 +155187,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154960,9 +155311,9 @@ webhooks: - active_lock_reason - body - reactions - label: *838 - organization: *819 - repository: *820 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -155042,8 +155393,8 @@ webhooks: type: string enum: - locked - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155879,11 +156230,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155980,8 +156331,8 @@ webhooks: format: uri user_view_type: type: string - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -156060,8 +156411,8 @@ webhooks: type: string enum: - milestoned - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156891,11 +157242,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156992,9 +157343,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *849 - organization: *819 - repository: *820 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -157886,11 +158237,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158467,8 +158818,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159280,11 +159631,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159403,8 +159754,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -159484,9 +159835,9 @@ webhooks: type: string enum: - pinned - enterprise: *817 - installation: *818 - issue: &850 + enterprise: *818 + installation: *819 + issue: &851 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -160292,11 +160643,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160415,8 +160766,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -160495,8 +160846,8 @@ webhooks: type: string enum: - reopened - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -161330,11 +161681,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161432,8 +161783,8 @@ webhooks: user_view_type: type: string type: *347 - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -162322,11 +162673,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162925,11 +163276,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *817 - installation: *818 - issue: *850 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *851 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163009,12 +163360,12 @@ webhooks: type: string enum: - typed - enterprise: *817 - installation: *818 - issue: *851 + enterprise: *818 + installation: *819 + issue: *852 type: *347 - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163095,7 +163446,7 @@ webhooks: type: string enum: - unassigned - assignee: &875 + assignee: &876 title: User type: - object @@ -163167,11 +163518,11 @@ webhooks: required: - login - id - enterprise: *817 - installation: *818 - issue: *851 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *852 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163250,12 +163601,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *817 - installation: *818 - issue: *851 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *852 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163335,8 +163686,8 @@ webhooks: type: string enum: - unlocked - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -164170,11 +164521,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164271,8 +164622,8 @@ webhooks: format: uri user_view_type: type: string - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164352,11 +164703,11 @@ webhooks: type: string enum: - unpinned - enterprise: *817 - installation: *818 - issue: *850 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *851 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164435,12 +164786,12 @@ webhooks: type: string enum: - untyped - enterprise: *817 - installation: *818 - issue: *851 + enterprise: *818 + installation: *819 + issue: *852 type: *347 - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164520,11 +164871,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164602,11 +164953,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164716,11 +165067,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164802,9 +165153,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: &852 + enterprise: *818 + installation: *819 + marketplace_purchase: &853 title: Marketplace Purchase type: object required: @@ -164892,8 +165243,8 @@ webhooks: type: integer unit_count: type: integer - organization: *819 - previous_marketplace_purchase: &853 + organization: *820 + previous_marketplace_purchase: &854 title: Marketplace Purchase type: object properties: @@ -164977,7 +165328,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *820 + repository: *821 sender: *4 required: - action @@ -165057,10 +165408,10 @@ webhooks: - changed effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: *852 - organization: *819 + enterprise: *818 + installation: *819 + marketplace_purchase: *853 + organization: *820 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165148,7 +165499,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *820 + repository: *821 sender: *4 required: - action @@ -165230,10 +165581,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: *852 - organization: *819 + enterprise: *818 + installation: *819 + marketplace_purchase: *853 + organization: *820 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165319,7 +165670,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *820 + repository: *821 sender: *4 required: - action @@ -165400,8 +165751,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 marketplace_purchase: title: Marketplace Purchase type: object @@ -165487,9 +165838,9 @@ webhooks: type: integer unit_count: type: integer - organization: *819 - previous_marketplace_purchase: *853 - repository: *820 + organization: *820 + previous_marketplace_purchase: *854 + repository: *821 sender: *4 required: - action @@ -165569,12 +165920,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: *852 - organization: *819 - previous_marketplace_purchase: *853 - repository: *820 + enterprise: *818 + installation: *819 + marketplace_purchase: *853 + organization: *820 + previous_marketplace_purchase: *854 + repository: *821 sender: *4 required: - action @@ -165676,11 +166027,11 @@ webhooks: type: string required: - to - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 sender: *4 required: - action @@ -165782,11 +166133,11 @@ webhooks: type: - string - 'null' - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 sender: *4 required: - action @@ -165865,11 +166216,11 @@ webhooks: type: string enum: - removed - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 sender: *4 required: - action @@ -165947,11 +166298,11 @@ webhooks: type: string enum: - added - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166029,7 +166380,7 @@ webhooks: required: - login - id - team: &854 + team: &855 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -166259,11 +166610,11 @@ webhooks: type: string enum: - removed - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166342,7 +166693,7 @@ webhooks: required: - login - id - team: *854 + team: *855 required: - action - scope @@ -166424,8 +166775,8 @@ webhooks: type: string enum: - checks_requested - installation: *818 - merge_group: &855 + installation: *819 + merge_group: &856 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -166444,15 +166795,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *510 + head_commit: *511 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -166538,10 +166889,10 @@ webhooks: - merged - invalidated - dequeued - installation: *818 - merge_group: *855 - organization: *819 - repository: *820 + installation: *819 + merge_group: *856 + organization: *820 + repository: *821 sender: *4 required: - action @@ -166614,7 +166965,7 @@ webhooks: type: string enum: - deleted - enterprise: *817 + enterprise: *818 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -166723,12 +167074,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *818 - organization: *819 + installation: *819 + organization: *820 repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -166808,11 +167159,11 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 - milestone: *849 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -166891,9 +167242,9 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - milestone: &856 + enterprise: *818 + installation: *819 + milestone: &857 title: Milestone description: A collection of related issues and pull requests. type: object @@ -167035,8 +167386,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167115,11 +167466,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - milestone: *849 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167229,11 +167580,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - milestone: *849 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167313,11 +167664,11 @@ webhooks: type: string enum: - opened - enterprise: *817 - installation: *818 - milestone: *856 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *857 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167396,11 +167747,11 @@ webhooks: type: string enum: - blocked - blocked_user: *844 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + blocked_user: *845 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167479,11 +167830,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *844 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + blocked_user: *845 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167559,7 +167910,7 @@ webhooks: enum: - created definition: *140 - enterprise: *817 + enterprise: *818 sender: *4 required: - action @@ -167639,8 +167990,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 sender: *4 required: - action @@ -167713,8 +168064,8 @@ webhooks: enum: - updated definition: *140 - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 sender: *4 required: - action @@ -167786,9 +168137,9 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 new_property_values: type: array @@ -167876,9 +168227,9 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - membership: &857 + enterprise: *818 + installation: *819 + membership: &858 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -167988,8 +168339,8 @@ webhooks: - role - organization_url - user - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168067,11 +168418,11 @@ webhooks: type: string enum: - member_added - enterprise: *817 - installation: *818 - membership: *857 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + membership: *858 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168150,8 +168501,8 @@ webhooks: type: string enum: - member_invited - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -168273,10 +168624,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 - user: *844 + user: *845 required: - action - invitation @@ -168354,11 +168705,11 @@ webhooks: type: string enum: - member_removed - enterprise: *817 - installation: *818 - membership: *857 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + membership: *858 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168445,11 +168796,11 @@ webhooks: properties: from: type: string - enterprise: *817 - installation: *818 - membership: *857 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + membership: *858 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168525,9 +168876,9 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 package: description: Information about the package. type: object @@ -169050,7 +169401,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &858 + items: &859 title: Ruby Gems metadata type: object properties: @@ -169147,7 +169498,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -169223,9 +169574,9 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 package: description: Information about the package. type: object @@ -169587,7 +169938,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *858 + items: *859 source_url: type: string format: uri @@ -169658,7 +170009,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -169839,12 +170190,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *817 + enterprise: *818 id: type: integer - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - id @@ -169921,7 +170272,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &859 + personal_access_token_request: &860 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -170071,10 +170422,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *817 - organization: *819 + enterprise: *818 + organization: *820 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170151,11 +170502,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *859 - enterprise: *817 - organization: *819 + personal_access_token_request: *860 + enterprise: *818 + organization: *820 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170231,11 +170582,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *859 - enterprise: *817 - organization: *819 + personal_access_token_request: *860 + enterprise: *818 + organization: *820 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170310,11 +170661,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *859 - organization: *819 - enterprise: *817 + personal_access_token_request: *860 + organization: *820 + enterprise: *818 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170419,7 +170770,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *860 + last_response: *861 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -170451,8 +170802,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 zen: description: Random string of GitHub zen. @@ -170697,10 +171048,10 @@ webhooks: - from required: - note - enterprise: *817 - installation: *818 - organization: *819 - project_card: &861 + enterprise: *818 + installation: *819 + organization: *820 + project_card: &862 title: Project Card type: object properties: @@ -170823,7 +171174,7 @@ webhooks: - creator - created_at - updated_at - repository: *820 + repository: *821 sender: *4 required: - action @@ -170904,11 +171255,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - project_card: *861 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_card: *862 + repository: *821 sender: *4 required: - action @@ -170988,9 +171339,9 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 project_card: title: Project Card type: object @@ -171120,7 +171471,7 @@ webhooks: repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -171214,11 +171565,11 @@ webhooks: - from required: - note - enterprise: *817 - installation: *818 - organization: *819 - project_card: *861 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_card: *862 + repository: *821 sender: *4 required: - action @@ -171312,9 +171663,9 @@ webhooks: - from required: - column_id - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 project_card: allOf: - title: Project Card @@ -171511,7 +171862,7 @@ webhooks: type: string required: - after_id - repository: *820 + repository: *821 sender: *4 required: - action @@ -171591,10 +171942,10 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 - organization: *819 - project: &863 + enterprise: *818 + installation: *819 + organization: *820 + project: &864 title: Project type: object properties: @@ -171721,7 +172072,7 @@ webhooks: - creator - created_at - updated_at - repository: *820 + repository: *821 sender: *4 required: - action @@ -171801,10 +172152,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - project_column: &862 + enterprise: *818 + installation: *819 + organization: *820 + project_column: &863 title: Project Column type: object properties: @@ -171844,7 +172195,7 @@ webhooks: - name - created_at - updated_at - repository: *820 + repository: *821 sender: *4 required: - action @@ -171923,14 +172274,14 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - project_column: *862 + enterprise: *818 + installation: *819 + organization: *820 + project_column: *863 repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -172019,11 +172370,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - project_column: *862 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_column: *863 + repository: *821 sender: *4 required: - action @@ -172103,11 +172454,11 @@ webhooks: type: string enum: - moved - enterprise: *817 - installation: *818 - organization: *819 - project_column: *862 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_column: *863 + repository: *821 sender: *4 required: - action @@ -172187,11 +172538,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - project: *863 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 + repository: *821 sender: *4 required: - action @@ -172271,14 +172622,14 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - project: *863 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -172379,11 +172730,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - project: *863 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 + repository: *821 sender: *4 required: - action @@ -172462,11 +172813,11 @@ webhooks: type: string enum: - reopened - enterprise: *817 - installation: *818 - organization: *819 - project: *863 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 + repository: *821 sender: *4 required: - action @@ -172547,8 +172898,8 @@ webhooks: type: string enum: - closed - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172630,8 +172981,8 @@ webhooks: type: string enum: - created - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172713,8 +173064,8 @@ webhooks: type: string enum: - deleted - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172836,8 +173187,8 @@ webhooks: type: string to: type: string - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172921,7 +173272,7 @@ webhooks: type: string enum: - archived - changes: &867 + changes: &868 type: object properties: archived_at: @@ -172937,9 +173288,9 @@ webhooks: - string - 'null' format: date-time - installation: *818 - organization: *819 - projects_v2_item: &864 + installation: *819 + organization: *820 + projects_v2_item: &865 title: Projects v2 Item description: An item belonging to a project type: object @@ -173079,9 +173430,9 @@ webhooks: - 'null' to: type: string - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173163,9 +173514,9 @@ webhooks: type: string enum: - created - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173246,9 +173597,9 @@ webhooks: type: string enum: - deleted - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173353,7 +173704,7 @@ webhooks: oneOf: - type: string - type: integer - - &865 + - &866 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -173377,7 +173728,7 @@ webhooks: required: - id - name - - &866 + - &867 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -173417,8 +173768,8 @@ webhooks: oneOf: - type: string - type: integer - - *865 - *866 + - *867 type: - 'null' - string @@ -173441,9 +173792,9 @@ webhooks: - 'null' required: - body - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173540,9 +173891,9 @@ webhooks: type: - string - 'null' - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173625,10 +173976,10 @@ webhooks: type: string enum: - restored - changes: *867 - installation: *818 - organization: *819 - projects_v2_item: *864 + changes: *868 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173710,8 +174061,8 @@ webhooks: type: string enum: - reopened - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -173793,9 +174144,9 @@ webhooks: type: string enum: - created - installation: *818 - organization: *819 - projects_v2_status_update: *868 + installation: *819 + organization: *820 + projects_v2_status_update: *869 sender: *4 required: - action @@ -173876,9 +174227,9 @@ webhooks: type: string enum: - deleted - installation: *818 - organization: *819 - projects_v2_status_update: *868 + installation: *819 + organization: *820 + projects_v2_status_update: *869 sender: *4 required: - action @@ -174024,9 +174375,9 @@ webhooks: - string - 'null' format: date - installation: *818 - organization: *819 - projects_v2_status_update: *868 + installation: *819 + organization: *820 + projects_v2_status_update: *869 sender: *4 required: - action @@ -174097,10 +174448,10 @@ webhooks: title: public event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - repository @@ -174177,13 +174528,13 @@ webhooks: type: string enum: - assigned - assignee: *844 - enterprise: *817 - installation: *818 - number: &869 + assignee: *845 + enterprise: *818 + installation: *819 + number: &870 description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -176532,7 +176883,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -176614,11 +176965,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -178960,7 +179311,7 @@ webhooks: - draft reason: type: string - repository: *820 + repository: *821 sender: *4 required: - action @@ -179042,11 +179393,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -181388,7 +181739,7 @@ webhooks: - draft reason: type: string - repository: *820 + repository: *821 sender: *4 required: - action @@ -181470,13 +181821,13 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: &870 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: &871 allOf: - - *669 + - *670 - type: object properties: allow_auto_merge: @@ -181538,7 +181889,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *820 + repository: *821 sender: *4 required: - action @@ -181619,12 +181970,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -181704,11 +182055,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *817 + enterprise: *818 milestone: *381 - number: *869 - organization: *819 - pull_request: &871 + number: *870 + organization: *820 + pull_request: &872 title: Pull Request type: object properties: @@ -184035,7 +184386,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -184114,11 +184465,11 @@ webhooks: type: string enum: - dequeued - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -186464,7 +186815,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *820 + repository: *821 sender: *4 required: - action @@ -186588,12 +186939,12 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -186673,11 +187024,11 @@ webhooks: type: string enum: - enqueued - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -189008,7 +189359,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -189088,11 +189439,11 @@ webhooks: type: string enum: - labeled - enterprise: *817 - installation: *818 - label: *838 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + label: *839 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -191440,7 +191791,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -191521,10 +191872,10 @@ webhooks: type: string enum: - locked - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -193870,7 +194221,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -193950,12 +194301,12 @@ webhooks: type: string enum: - milestoned - enterprise: *817 + enterprise: *818 milestone: *381 - number: *869 - organization: *819 - pull_request: *871 - repository: *820 + number: *870 + organization: *820 + pull_request: *872 + repository: *821 sender: *4 required: - action @@ -194034,12 +194385,12 @@ webhooks: type: string enum: - opened - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -194120,12 +194471,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -194205,12 +194556,12 @@ webhooks: type: string enum: - reopened - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -194585,9 +194936,9 @@ webhooks: - start_side - side - reactions - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: type: object properties: @@ -196817,7 +197168,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *820 + repository: *821 sender: *4 required: - action @@ -196897,7 +197248,7 @@ webhooks: type: string enum: - deleted - comment: &873 + comment: &874 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -197190,9 +197541,9 @@ webhooks: - start_side - side - reactions - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: type: object properties: @@ -199410,7 +199761,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *820 + repository: *821 sender: *4 required: - action @@ -199490,11 +199841,11 @@ webhooks: type: string enum: - edited - changes: *872 - comment: *873 - enterprise: *817 - installation: *818 - organization: *819 + changes: *873 + comment: *874 + enterprise: *818 + installation: *819 + organization: *820 pull_request: type: object properties: @@ -201715,7 +202066,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *820 + repository: *821 sender: *4 required: - action @@ -201796,9 +202147,9 @@ webhooks: type: string enum: - dismissed - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -204031,7 +204382,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 + repository: *821 review: description: The review that was affected. type: object @@ -204282,9 +204633,9 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -206398,8 +206749,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 - review: &874 + repository: *821 + review: &875 description: The review that was affected. type: object properties: @@ -206637,12 +206988,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -208989,7 +209340,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_reviewer: title: User type: @@ -209075,12 +209426,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -211434,7 +211785,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211629,12 +211980,12 @@ webhooks: type: string enum: - review_requested - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -213983,7 +214334,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_reviewer: title: User type: @@ -214070,12 +214421,12 @@ webhooks: type: string enum: - review_requested - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -216415,7 +216766,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_team: title: Team description: Groups of organization members that gives permissions @@ -216599,9 +216950,9 @@ webhooks: type: string enum: - submitted - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -218837,8 +219188,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 - review: *874 + repository: *821 + review: *875 sender: *4 required: - action @@ -218918,9 +219269,9 @@ webhooks: type: string enum: - resolved - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -221051,7 +221402,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 + repository: *821 sender: *4 thread: type: object @@ -221448,9 +221799,9 @@ webhooks: type: string enum: - unresolved - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -223564,7 +223915,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 + repository: *821 sender: *4 thread: type: object @@ -223963,10 +224314,10 @@ webhooks: type: string before: type: string - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -226301,7 +226652,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -226383,11 +226734,11 @@ webhooks: type: string enum: - unassigned - assignee: *875 - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + assignee: *876 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -228737,7 +229088,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -228816,11 +229167,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *817 - installation: *818 - label: *838 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + label: *839 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -231159,7 +231510,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -231240,10 +231591,10 @@ webhooks: type: string enum: - unlocked - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -233572,7 +233923,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -233775,7 +234126,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *817 + enterprise: *818 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -233870,8 +234221,8 @@ webhooks: - url - author - committer - installation: *818 - organization: *819 + installation: *819 + organization: *820 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -234459,9 +234810,9 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 registry_package: type: object properties: @@ -234938,7 +235289,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *858 + items: *859 summary: type: string tag_name: @@ -234994,7 +235345,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -235072,9 +235423,9 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 registry_package: type: object properties: @@ -235386,7 +235737,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *858 + items: *859 summary: type: string tag_name: @@ -235436,7 +235787,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -235513,10 +235864,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - release: &876 + enterprise: *818 + installation: *819 + organization: *820 + release: &877 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -235847,7 +236198,7 @@ webhooks: - updated_at - zipball_url - body - repository: *820 + repository: *821 sender: *4 required: - action @@ -235924,11 +236275,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - release: *876 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *877 + repository: *821 sender: *4 required: - action @@ -236045,11 +236396,11 @@ webhooks: type: boolean required: - to - enterprise: *817 - installation: *818 - organization: *819 - release: *876 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *877 + repository: *821 sender: *4 required: - action @@ -236127,9 +236478,9 @@ webhooks: type: string enum: - prereleased - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -236465,7 +236816,7 @@ webhooks: - string - 'null' format: uri - repository: *820 + repository: *821 sender: *4 required: - action @@ -236541,10 +236892,10 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 - release: &877 + enterprise: *818 + installation: *819 + organization: *820 + release: &878 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -236877,7 +237228,7 @@ webhooks: - string - 'null' format: uri - repository: *820 + repository: *821 sender: *4 required: - action @@ -236953,11 +237304,11 @@ webhooks: type: string enum: - released - enterprise: *817 - installation: *818 - organization: *819 - release: *876 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *877 + repository: *821 sender: *4 required: - action @@ -237033,11 +237384,11 @@ webhooks: type: string enum: - unpublished - enterprise: *817 - installation: *818 - organization: *819 - release: *877 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *878 + repository: *821 sender: *4 required: - action @@ -237113,11 +237464,11 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - repository_advisory: *722 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + repository_advisory: *723 sender: *4 required: - action @@ -237193,11 +237544,11 @@ webhooks: type: string enum: - reported - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - repository_advisory: *722 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + repository_advisory: *723 sender: *4 required: - action @@ -237273,10 +237624,10 @@ webhooks: type: string enum: - archived - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237353,10 +237704,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237434,10 +237785,10 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237522,10 +237873,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237640,10 +237991,10 @@ webhooks: - 'null' items: type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237715,10 +238066,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 status: type: string @@ -237799,10 +238150,10 @@ webhooks: type: string enum: - privatized - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237879,10 +238230,10 @@ webhooks: type: string enum: - publicized - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237976,10 +238327,10 @@ webhooks: - name required: - repository - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -238059,10 +238410,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 repository_ruleset: *179 sender: *4 required: @@ -238141,10 +238492,10 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 repository_ruleset: *179 sender: *4 required: @@ -238223,10 +238574,10 @@ webhooks: type: string enum: - edited - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 repository_ruleset: *179 changes: type: object @@ -238288,16 +238639,16 @@ webhooks: properties: added: type: array - items: *690 + items: *691 deleted: type: array - items: *690 + items: *691 updated: type: array items: type: object properties: - rule: *690 + rule: *691 changes: type: object properties: @@ -238534,10 +238885,10 @@ webhooks: - from required: - owner - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -238615,10 +238966,10 @@ webhooks: type: string enum: - unarchived - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -238696,7 +239047,7 @@ webhooks: type: string enum: - create - alert: &878 + alert: &879 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -238820,10 +239171,10 @@ webhooks: type: string enum: - open - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239033,10 +239384,10 @@ webhooks: type: string enum: - dismissed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239114,11 +239465,11 @@ webhooks: type: string enum: - reopen - alert: *878 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *879 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239320,10 +239671,10 @@ webhooks: enum: - fixed - open - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239341,7 +239692,7 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -239349,8 +239700,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -239394,14 +239745,14 @@ webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &879 + - assigned + alert: &880 type: object properties: number: *119 @@ -239515,10 +239866,93 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + assignee: *4 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239599,11 +240033,11 @@ webhooks: type: string enum: - created - alert: *879 - installation: *818 - location: *880 - organization: *819 - repository: *820 + alert: *880 + installation: *819 + location: *881 + organization: *820 + repository: *821 sender: *4 required: - location @@ -239841,11 +240275,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239923,11 +240357,11 @@ webhooks: type: string enum: - reopened - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -240005,11 +240439,94 @@ webhooks: type: string enum: - resolved - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *880 + assignee: *4 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -240087,11 +240604,11 @@ webhooks: type: string enum: - validated - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -240221,10 +240738,10 @@ webhooks: - organization - enterprise - - repository: *820 - enterprise: *817 - installation: *818 - organization: *819 + repository: *821 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -240302,11 +240819,11 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - security_advisory: &881 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + security_advisory: &882 description: The details of the security advisory, including summary, description, and severity. type: object @@ -240492,11 +241009,11 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - security_advisory: *881 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + security_advisory: *882 sender: *4 required: - action @@ -240569,10 +241086,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -240759,10 +241276,10 @@ webhooks: type: object properties: security_and_analysis: *391 - enterprise: *817 - installation: *818 - organization: *819 - repository: *449 + enterprise: *818 + installation: *819 + organization: *820 + repository: *450 sender: *4 required: - changes @@ -240840,12 +241357,12 @@ webhooks: type: string enum: - cancelled - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: &882 + sponsorship: &883 type: object properties: created_at: @@ -241150,12 +241667,12 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - sponsorship @@ -241243,12 +241760,12 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - changes @@ -241325,17 +241842,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &883 + effective_date: &884 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - sponsorship @@ -241409,7 +241926,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &884 + changes: &885 type: object properties: tier: @@ -241453,13 +241970,13 @@ webhooks: - from required: - tier - effective_date: *883 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + effective_date: *884 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - changes @@ -241536,13 +242053,13 @@ webhooks: type: string enum: - tier_changed - changes: *884 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + changes: *885 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - changes @@ -241616,10 +242133,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -241703,10 +242220,10 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242140,15 +242657,15 @@ webhooks: type: - string - 'null' - enterprise: *817 + enterprise: *818 id: description: The unique identifier of the status. type: integer - installation: *818 + installation: *819 name: type: string - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 sha: description: The Commit SHA. @@ -242264,9 +242781,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242356,9 +242873,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242448,9 +242965,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242540,9 +243057,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242619,12 +243136,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - team: &885 + team: &886 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -242854,9 +243371,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -243326,7 +243843,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -243402,9 +243919,9 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -243874,7 +244391,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -243951,9 +244468,9 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -244423,7 +244940,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -244567,9 +245084,9 @@ webhooks: - from required: - permissions - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -245039,7 +245556,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - changes @@ -245117,9 +245634,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -245589,7 +246106,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -245665,10 +246182,10 @@ webhooks: type: string enum: - started - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -245741,17 +246258,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *817 + enterprise: *818 inputs: type: - object - 'null' additionalProperties: true - installation: *818 - organization: *819 + installation: *819 + organization: *820 ref: type: string - repository: *820 + repository: *821 sender: *4 workflow: type: string @@ -245833,10 +246350,10 @@ webhooks: type: string enum: - completed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: allOf: @@ -246092,7 +246609,7 @@ webhooks: type: string required: - conclusion - deployment: *576 + deployment: *577 required: - action - repository @@ -246171,10 +246688,10 @@ webhooks: type: string enum: - in_progress - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: allOf: @@ -246456,7 +246973,7 @@ webhooks: required: - status - steps - deployment: *576 + deployment: *577 required: - action - repository @@ -246535,10 +247052,10 @@ webhooks: type: string enum: - queued - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: type: object @@ -246684,7 +247201,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *576 + deployment: *577 required: - action - repository @@ -246763,10 +247280,10 @@ webhooks: type: string enum: - waiting - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: type: object @@ -246913,7 +247430,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *576 + deployment: *577 required: - action - repository @@ -246993,12 +247510,12 @@ webhooks: type: string enum: - completed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Workflow Run type: object @@ -248017,12 +248534,12 @@ webhooks: type: string enum: - in_progress - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Workflow Run type: object @@ -249026,12 +249543,12 @@ webhooks: type: string enum: - requested - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 1dd3c5f00..007705989 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -5459,6 +5459,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6607,6 +6615,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7528,6 +7544,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -8014,6 +8038,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10358,6 +10390,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11538,6 +11578,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12582,6 +12630,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13329,6 +13385,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -30285,6 +30349,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -31164,6 +31236,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -32263,6 +32343,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -33759,6 +33847,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -64308,6 +64404,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -68557,7 +68676,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } } } @@ -169635,6 +169769,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -170798,6 +170940,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -214077,21 +214227,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -246403,6 +246571,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -437538,6 +437729,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -613721,6 +613920,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", @@ -616507,7 +616729,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -616582,6 +616804,13 @@ "string", "null" ] + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] } }, "anyOf": [ @@ -616589,6 +616818,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -616598,6 +616832,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -617847,7 +618093,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -617861,7 +618127,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -711633,6 +711899,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -770950,6 +771224,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -778451,51 +778733,732 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for user", - "description": "Get a specific field for a user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "name": "project_number", - "description": "The project's number.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.", + "name": "project_number", + "description": "The project's number.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { @@ -778702,21 +779665,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -851229,6 +852210,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -854008,6 +854996,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -1010895,6 +1011890,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1014018,6 +1015021,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1017046,6 +1018057,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1020074,6 +1021093,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1023236,6 +1024263,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1026405,6 +1027440,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1031569,6 +1032612,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1498393,206 +1499444,4337 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "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": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1500468,7 +1505650,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1500484,23 +1505666,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1500565,15 +1505745,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "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).\"", @@ -1502448,6 +1507812,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1502463,21 +1507828,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1502544,13 +1507907,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1504623,11 +1509986,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1504694,13 +1510057,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1504711,9 +1510074,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1504733,12 +1510093,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1504838,9 +1510192,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1504882,7 +1510233,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1506757,285 +1512109,1126 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "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": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": [ - "object", - "null" - ], - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1508912,8 +1515105,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1508927,21 +1515119,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1509006,184 +1515199,856 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - }, - "url": { - "type": "string", - "format": "uri" } - } - }, - "external_identifier": { - "type": "string" + ] }, - "external_reference": { + "resolution_comment": { "type": [ "string", "null" ], - "format": "uri" + "description": "An optional comment to resolve an alert." }, - "fix_reason": { - "type": "string" + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." }, - "fixed_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "fixed_in": { - "type": "string" + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "id": { - "type": "integer" + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "node_id": { - "type": "string" + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, - "number": { - "type": "integer" + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "severity": { - "type": "string" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "assigned_to": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] } } @@ -1511063,8 +1517928,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1511078,21 +1517942,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1511157,7 +1518022,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1512011,96 +1518876,6 @@ } } }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1512126,6 +1518901,354 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "examples": [ + "commit" + ] + }, + "details": { + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1513884,10 +1521007,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1513899,8 +1521197,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1513909,13 +1521208,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1513980,13 +1521279,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1514834,378 +1522133,120 @@ } } }, - "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).\"", + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, "id": { - "description": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", - "node_id" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "oneOf": [ - { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1516965,185 +1524006,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1517155,9 +1524021,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1517166,11 +1524031,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1517237,13 +1524102,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1519989,11 +1526854,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1520060,13 +1526925,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1522812,11 +1529677,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1522883,13 +1529748,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1523737,6 +1530602,174 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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).\"", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 0aa137c96..9d52e34b9 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -915,7 +915,7 @@ paths: - subscriptions_url - type - url - type: &411 + type: &412 type: string description: The type of credit the user is receiving. enum: @@ -1081,7 +1081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &724 + - &725 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1810,7 +1810,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &734 + schema: &735 title: Scim Error description: Scim Error type: object @@ -2352,6 +2352,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -9101,7 +9108,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &735 + '401': &736 description: Authorization failure '404': *6 x-github: @@ -13366,7 +13373,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &516 + instances_url: &517 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13402,7 +13409,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &517 + dismissed_reason: &518 type: - string - 'null' @@ -13413,14 +13420,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &518 + dismissed_comment: &519 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &519 + rule: &520 type: object properties: id: @@ -13481,7 +13488,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &520 + tool: &521 type: object properties: name: *105 @@ -13492,15 +13499,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *106 - most_recent_instance: &521 + most_recent_instance: &522 type: object properties: - ref: &514 + ref: &515 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &531 + analysis_key: &532 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13511,7 +13518,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &532 + category: &533 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -17309,7 +17316,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &567 + - &568 name: has in: query description: |- @@ -17426,7 +17433,7 @@ paths: - direct - transitive - - security_advisory: &568 + security_advisory: &569 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17662,7 +17669,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: &569 + auto_dismissed_at: &570 type: - string - 'null' @@ -18807,7 +18814,7 @@ paths: - name - created_on examples: - default: &415 + default: &416 value: total_count: 2 network_configurations: @@ -19030,7 +19037,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &416 + - &417 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -19042,7 +19049,7 @@ paths: description: Response content: application/json: - schema: &417 + schema: &418 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -19081,7 +19088,7 @@ paths: - subnet_id - region examples: - default: &418 + default: &419 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -21134,7 +21141,7 @@ paths: - object rules: type: array - items: &690 + items: &691 title: Repository Rule type: object description: A repository rule. @@ -21143,7 +21150,7 @@ paths: - *160 - *161 - *162 - - &687 + - &688 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -21237,7 +21244,7 @@ paths: - *176 - *177 - *178 - - &688 + - &689 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21632,6 +21639,25 @@ paths: schema: type: string - &402 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &403 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -21647,7 +21673,7 @@ paths: - *17 - *102 - *103 - - &403 + - &404 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21656,7 +21682,7 @@ paths: required: false schema: type: string - - &404 + - &405 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21665,7 +21691,7 @@ paths: schema: type: boolean default: false - - &405 + - &406 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21674,7 +21700,7 @@ paths: schema: type: boolean default: false - - &406 + - &407 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21690,7 +21716,7 @@ paths: application/json: schema: type: array - items: &407 + items: &408 type: object properties: number: *119 @@ -21706,14 +21732,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &702 + state: &703 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &703 + resolution: &704 type: - string - 'null' @@ -21820,14 +21846,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &704 + - &705 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &706 + - &707 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21884,7 +21910,7 @@ paths: - blob_url - commit_sha - commit_url - - &707 + - &708 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -21945,7 +21971,7 @@ paths: - page_url - commit_sha - commit_url - - &708 + - &709 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21960,7 +21986,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &709 + - &710 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21975,7 +22001,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &710 + - &711 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21990,7 +22016,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &711 + - &712 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -22005,7 +22031,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &712 + - &713 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -22020,7 +22046,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &713 + - &714 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -22035,7 +22061,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &714 + - &715 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -22050,7 +22076,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &715 + - &716 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -22065,7 +22091,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &716 + - &717 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -22080,7 +22106,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &717 + - &718 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -22095,7 +22121,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &718 + - &719 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -22120,7 +22146,7 @@ paths: - type: 'null' - *4 examples: - default: &408 + default: &409 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -22329,7 +22355,7 @@ paths: description: Response content: application/json: - schema: &409 + schema: &410 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -22416,7 +22442,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *185 examples: - default: &410 + default: &411 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -22552,7 +22578,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &412 + - &413 name: advanced_security_product in: query description: | @@ -22572,7 +22598,7 @@ paths: description: Success content: application/json: - schema: &413 + schema: &414 type: object properties: total_advanced_security_committers: @@ -22635,7 +22661,7 @@ paths: required: - repositories examples: - default: &414 + default: &415 value: total_advanced_security_committers: 2 total_count: 2 @@ -23287,7 +23313,19 @@ paths: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *23 '403': *27 @@ -25782,7 +25820,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &762 + sub_issues_summary: &763 title: Sub-issues Summary type: object properties: @@ -25803,7 +25841,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &763 + issue_dependencies_summary: &764 title: Issue Dependencies Summary type: object properties: @@ -25822,7 +25860,7 @@ paths: - total_blocking issue_field_values: type: array - items: &764 + items: &765 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25917,7 +25955,7 @@ paths: - user - created_at - updated_at - comment: &625 + comment: &626 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -26483,7 +26521,7 @@ paths: url: type: string format: uri - user: &776 + user: &777 title: Public User description: Public User type: object @@ -29840,14 +29878,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &438 + - &439 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &439 + - &440 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29909,7 +29947,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &450 + '301': &451 description: Moved permanently content: application/json: @@ -29931,7 +29969,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &654 + - &655 name: all description: If `true`, show notifications marked as read. in: query @@ -29939,7 +29977,7 @@ paths: schema: type: boolean default: false - - &655 + - &656 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29949,7 +29987,7 @@ paths: type: boolean default: false - *209 - - &656 + - &657 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -30493,7 +30531,7 @@ paths: - url - subscription_url examples: - default: &657 + default: &658 value: - id: '1' repository: @@ -31474,7 +31512,7 @@ paths: type: array items: *145 examples: - default: &663 + default: &664 value: - property_name: environment value: production @@ -31524,7 +31562,7 @@ paths: required: - properties examples: - default: &664 + default: &665 value: properties: - property_name: environment @@ -32415,7 +32453,7 @@ paths: type: integer repository_cache_usages: type: array - items: &455 + items: &456 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -34538,7 +34576,7 @@ paths: type: array items: *263 examples: - default: &779 + default: &780 value: total_count: 1 repositories: @@ -35582,7 +35620,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &476 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -35617,7 +35655,7 @@ paths: - key_id - key examples: - default: &476 + default: &477 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -36030,7 +36068,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *81 - - &460 + - &461 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -37237,12 +37275,12 @@ paths: required: - subject_digests examples: - default: &806 + default: &807 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &807 + withPredicateType: &808 value: subject_digests: - sha256:abc123 @@ -37301,7 +37339,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &808 + default: &809 value: attestations_subject_digests: - sha256:abc: @@ -37650,7 +37688,7 @@ paths: initiator: type: string examples: - default: &489 + default: &490 value: attestations: - bundle: @@ -38572,7 +38610,7 @@ paths: be returned. in: query required: false - schema: &515 + schema: &516 type: string description: Severity of a code scanning alert. enum: @@ -39623,7 +39661,7 @@ paths: machine: anyOf: - type: 'null' - - &544 + - &545 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -40575,7 +40613,7 @@ paths: - updated_at - visibility examples: - default: &545 + default: &546 value: total_count: 2 secrets: @@ -40613,7 +40651,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &547 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -40648,7 +40686,7 @@ paths: - key_id - key examples: - default: &547 + default: &548 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40680,7 +40718,7 @@ paths: application/json: schema: *307 examples: - default: &549 + default: &550 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -42409,7 +42447,7 @@ paths: description: Response content: application/json: - schema: &572 + schema: &573 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -42428,7 +42466,7 @@ paths: - key_id - key examples: - default: &573 + default: &574 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -42758,7 +42796,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *81 - - &581 + - &582 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -42766,7 +42804,7 @@ paths: required: false schema: type: string - - &582 + - &583 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -42774,7 +42812,7 @@ paths: required: false schema: type: string - - &583 + - &584 name: time_period description: |- The time period to filter by. @@ -42790,7 +42828,7 @@ paths: - week - month default: month - - &584 + - &585 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -42815,7 +42853,7 @@ paths: application/json: schema: type: array - items: &585 + items: &586 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -42978,7 +43016,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &586 + default: &587 value: - id: 21 number: 42 @@ -43069,7 +43107,7 @@ paths: - *97 - *98 - *99 - - &587 + - &588 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -43095,7 +43133,7 @@ paths: application/json: schema: type: array - items: &588 + items: &589 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -43222,7 +43260,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &589 + default: &590 value: - id: 21 number: 42 @@ -43568,7 +43606,7 @@ paths: description: Response content: application/json: - schema: &433 + schema: &434 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -43658,7 +43696,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &434 + default: &435 value: group_id: '123' group_name: Octocat admins @@ -43713,7 +43751,7 @@ paths: description: Response content: application/json: - schema: &431 + schema: &432 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -43753,7 +43791,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &432 + default: &433 value: groups: - group_id: '123' @@ -45082,7 +45120,7 @@ paths: application/json: schema: *20 examples: - default: &620 + default: &621 value: id: 1 account: @@ -45310,7 +45348,7 @@ paths: required: true content: application/json: - schema: &621 + schema: &622 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -46178,7 +46216,7 @@ paths: application/json: schema: *352 examples: - default: &543 + default: &544 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -47436,7 +47474,7 @@ paths: parameters: - *81 - *358 - - &791 + - &792 name: repo_name description: repo_name parameter in: path @@ -48782,7 +48820,7 @@ paths: - nuget - container - *81 - - &792 + - &793 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -48823,7 +48861,7 @@ paths: default: *363 '403': *27 '401': *23 - '400': &794 + '400': &795 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -50649,7 +50687,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &868 + - &869 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -50923,7 +50961,7 @@ paths: content: oneOf: - *219 - - &556 + - &557 title: Pull Request Simple description: Pull Request Simple type: object @@ -51168,7 +51206,7 @@ paths: - review_comment - self author_association: *206 - auto_merge: &666 + auto_merge: &667 title: Auto merge description: The status of auto merging a pull request. type: @@ -51550,7 +51588,7 @@ paths: - updated_at - project_url examples: - default: &811 + default: &812 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -51682,7 +51720,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - *380 - - &812 + - &813 name: field_id description: The unique identifier of the field. in: path @@ -51697,7 +51735,7 @@ paths: application/json: schema: *383 examples: - default: &813 + default: &814 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -51706,17 +51744,29 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: @@ -53487,7 +53537,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &450 title: Full Repository description: Full Repository type: object @@ -53952,7 +54002,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &561 + code_of_conduct: &562 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -54066,7 +54116,7 @@ paths: - network_count - subscribers_count examples: - default: &451 + default: &452 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -54619,7 +54669,7 @@ paths: - *81 - *17 - *19 - - &689 + - &690 name: targets description: | A comma-separated list of rule targets to filter by. @@ -54834,7 +54884,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *81 - - &691 + - &692 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -54846,14 +54896,14 @@ paths: x-multi-segment: true - *289 - *99 - - &692 + - &693 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &693 + - &694 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -54873,7 +54923,7 @@ paths: description: Response content: application/json: - schema: &694 + schema: &695 title: Rule Suites description: Response type: array @@ -54929,7 +54979,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &695 + default: &696 value: - id: 21 actor_id: 12 @@ -54973,7 +55023,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *81 - - &696 + - &697 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -54989,7 +55039,7 @@ paths: description: Response content: application/json: - schema: &697 + schema: &698 title: Rule Suite description: Response type: object @@ -55096,7 +55146,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &698 + default: &699 value: id: 21 actor_id: 12 @@ -55424,10 +55474,11 @@ paths: - *400 - *401 - *402 + - *403 - *104 - *19 - *17 - - &700 + - &701 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -55437,7 +55488,7 @@ paths: required: false schema: type: string - - &701 + - &702 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -55447,10 +55498,10 @@ paths: required: false schema: type: string - - *403 - *404 - *405 - *406 + - *407 responses: '200': description: Response @@ -55458,9 +55509,9 @@ paths: application/json: schema: type: array - items: *407 + items: *408 examples: - default: *408 + default: *409 headers: Link: *41 '404': *6 @@ -55495,9 +55546,9 @@ paths: description: Response content: application/json: - schema: *409 + schema: *410 examples: - default: *410 + default: *411 '403': *27 '404': *6 patch: @@ -55650,7 +55701,7 @@ paths: application/json: schema: type: array - items: &722 + items: &723 description: A repository security advisory. type: object properties: @@ -55894,7 +55945,7 @@ paths: login: type: string description: The username of the user credited. - type: *411 + type: *412 credits_detailed: type: - array @@ -55905,7 +55956,7 @@ paths: type: object properties: user: *4 - type: *411 + type: *412 state: type: string description: The state of the user's acceptance of the @@ -55969,7 +56020,7 @@ paths: - private_fork additionalProperties: false examples: - default: &723 + default: &724 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -56440,7 +56491,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *81 - - *412 + - *413 - *17 - *19 responses: @@ -56448,9 +56499,9 @@ paths: description: Success content: application/json: - schema: *413 + schema: *414 examples: - default: *414 + default: *415 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -56733,7 +56784,7 @@ paths: type: array items: *137 examples: - default: *415 + default: *416 headers: Link: *41 x-github: @@ -56934,15 +56985,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *81 - - *416 + - *417 responses: '200': description: Response content: application/json: - schema: *417 + schema: *418 examples: - default: *418 + default: *419 headers: Link: *41 x-github: @@ -56980,7 +57031,7 @@ paths: description: Response content: application/json: - schema: &440 + schema: &441 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -57032,7 +57083,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &441 + default: &442 value: groups: - group_id: '123' @@ -57240,7 +57291,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &420 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -57639,7 +57690,7 @@ paths: - repos_count - organization examples: - default: &420 + default: &421 value: id: 1 node_id: MDQ6VGVhbTE= @@ -57716,9 +57767,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 x-github: githubCloudOnly: false @@ -57803,16 +57854,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '201': description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 '422': *15 '403': *27 @@ -57882,7 +57933,7 @@ paths: application/json: schema: type: array - items: &421 + items: &422 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -57993,7 +58044,7 @@ paths: - updated_at - url examples: - default: &766 + default: &767 value: - author: login: octocat @@ -58102,9 +58153,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: &422 + default: &423 value: author: login: octocat @@ -58178,7 +58229,7 @@ paths: parameters: - *81 - *204 - - &423 + - &424 name: discussion_number description: The number that identifies the discussion. in: path @@ -58190,9 +58241,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *422 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58216,7 +58267,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 requestBody: required: false content: @@ -58239,9 +58290,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: &767 + default: &768 value: author: login: octocat @@ -58313,7 +58364,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 responses: '204': description: Response @@ -58341,7 +58392,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 - *104 - *17 - *19 @@ -58352,7 +58403,7 @@ paths: application/json: schema: type: array - items: &424 + items: &425 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -58432,7 +58483,7 @@ paths: - updated_at - url examples: - default: &768 + default: &769 value: - author: login: octocat @@ -58502,7 +58553,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 requestBody: required: true content: @@ -58524,9 +58575,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: &425 + default: &426 value: author: login: octocat @@ -58594,8 +58645,8 @@ paths: parameters: - *81 - *204 - - *423 - - &426 + - *424 + - &427 name: comment_number description: The number that identifies the comment. in: path @@ -58607,9 +58658,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *425 + default: *426 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58633,8 +58684,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 requestBody: required: true content: @@ -58656,9 +58707,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: &769 + default: &770 value: author: login: octocat @@ -58724,8 +58775,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 responses: '204': description: Response @@ -58753,8 +58804,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -58780,7 +58831,7 @@ paths: application/json: schema: type: array - items: &427 + items: &428 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -58824,7 +58875,7 @@ paths: - content - created_at examples: - default: &429 + default: &430 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58876,8 +58927,8 @@ paths: parameters: - *81 - *204 - - *423 - - *426 + - *424 + - *427 requestBody: required: true content: @@ -58910,9 +58961,9 @@ paths: team discussion comment content: application/json: - schema: *427 + schema: *428 examples: - default: &428 + default: &429 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58941,9 +58992,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58968,9 +59019,9 @@ paths: parameters: - *81 - *204 - - *423 - - *426 - - &430 + - *424 + - *427 + - &431 name: reaction_id description: The unique identifier of the reaction. in: path @@ -59004,7 +59055,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -59030,9 +59081,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 x-github: @@ -59060,7 +59111,7 @@ paths: parameters: - *81 - *204 - - *423 + - *424 requestBody: required: true content: @@ -59092,16 +59143,16 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59126,8 +59177,8 @@ paths: parameters: - *81 - *204 - - *423 - - *430 + - *424 + - *431 responses: '204': description: Response @@ -59157,9 +59208,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *432 examples: - default: *432 + default: *433 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -59203,9 +59254,9 @@ paths: description: Response content: application/json: - schema: *433 + schema: *434 examples: - default: *434 + default: *435 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59346,7 +59397,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &436 title: Team Membership description: Team Membership type: object @@ -59374,7 +59425,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &770 + response-if-user-is-a-team-maintainer: &771 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -59437,9 +59488,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *436 examples: - response-if-users-membership-with-team-is-now-pending: &771 + response-if-users-membership-with-team-is-now-pending: &772 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -59512,7 +59563,7 @@ paths: application/json: schema: type: array - items: &436 + items: &437 title: Team Project description: A team's access to a project. type: object @@ -59581,7 +59632,7 @@ paths: - updated_at - permissions examples: - default: &772 + default: &773 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59646,7 +59697,7 @@ paths: parameters: - *81 - *204 - - &437 + - &438 name: project_id description: The unique identifier of the project. in: path @@ -59658,9 +59709,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *437 examples: - default: &773 + default: &774 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59724,7 +59775,7 @@ paths: parameters: - *81 - *204 - - *437 + - *438 requestBody: required: false content: @@ -59793,7 +59844,7 @@ paths: parameters: - *81 - *204 - - *437 + - *438 responses: '204': description: Response @@ -59864,14 +59915,14 @@ paths: parameters: - *81 - *204 - - *438 - *439 + - *440 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &774 + schema: &775 title: Team Repository description: A team's access to a repository. type: object @@ -60514,8 +60565,8 @@ paths: parameters: - *81 - *204 - - *438 - *439 + - *440 requestBody: required: false content: @@ -60562,8 +60613,8 @@ paths: parameters: - *81 - *204 - - *438 - *439 + - *440 responses: '204': description: Response @@ -60596,9 +60647,9 @@ paths: description: Response content: application/json: - schema: *440 + schema: *441 examples: - default: *441 + default: *442 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60664,7 +60715,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *441 examples: default: value: @@ -60709,7 +60760,7 @@ paths: type: array items: *292 examples: - response-if-child-teams-exist: &775 + response-if-child-teams-exist: &776 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -60836,7 +60887,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &442 + - &443 name: card_id description: The unique identifier of the card. in: path @@ -60848,7 +60899,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &444 title: Project Card description: Project cards represent a scope of work. type: object @@ -60923,7 +60974,7 @@ paths: - created_at - updated_at examples: - default: &444 + default: &445 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -60979,7 +61030,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *442 + - *443 requestBody: required: false content: @@ -61009,9 +61060,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *444 examples: - default: *444 + default: *445 '304': *35 '403': *27 '401': *23 @@ -61038,7 +61089,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *442 + - *443 responses: '204': description: Response @@ -61082,7 +61133,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *442 + - *443 requestBody: required: true content: @@ -61195,7 +61246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &445 + - &446 name: column_id description: The unique identifier of the column. in: path @@ -61207,7 +61258,7 @@ paths: description: Response content: application/json: - schema: &446 + schema: &447 title: Project Column description: Project columns contain cards of work. type: object @@ -61261,7 +61312,7 @@ paths: - created_at - updated_at examples: - default: &447 + default: &448 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -61296,7 +61347,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *445 + - *446 requestBody: required: true content: @@ -61321,9 +61372,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *447 examples: - default: *447 + default: *448 '304': *35 '403': *27 '401': *23 @@ -61348,7 +61399,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *445 + - *446 responses: '204': description: Response @@ -61377,7 +61428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *445 + - *446 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -61398,7 +61449,7 @@ paths: application/json: schema: type: array - items: *443 + items: *444 examples: default: value: @@ -61457,7 +61508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *445 + - *446 requestBody: required: true content: @@ -61501,9 +61552,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *444 examples: - default: *444 + default: *445 '304': *35 '403': *27 '401': *23 @@ -61559,7 +61610,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *445 + - *446 requestBody: required: true content: @@ -61620,7 +61671,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *437 + - *438 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -61677,7 +61728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *437 + - *438 - *132 requestBody: required: false @@ -61732,7 +61783,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *437 + - *438 - *132 responses: '204': @@ -61764,7 +61815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *437 + - *438 - *132 responses: '200': @@ -61862,7 +61913,7 @@ paths: resources: type: object properties: - core: &448 + core: &449 title: Rate Limit type: object properties: @@ -61879,21 +61930,21 @@ paths: - remaining - reset - used - graphql: *448 - search: *448 - code_search: *448 - source_import: *448 - integration_manifest: *448 - code_scanning_upload: *448 - actions_runner_registration: *448 - scim: *448 - dependency_snapshots: *448 - dependency_sbom: *448 - code_scanning_autofix: *448 + graphql: *449 + search: *449 + code_search: *449 + source_import: *449 + integration_manifest: *449 + code_scanning_upload: *449 + actions_runner_registration: *449 + scim: *449 + dependency_snapshots: *449 + dependency_sbom: *449 + code_scanning_autofix: *449 required: - core - search - rate: *448 + rate: *449 required: - rate - resources @@ -61998,14 +62049,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *449 + schema: *450 examples: default-response: summary: Default response @@ -62510,7 +62561,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *450 + '301': *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62528,8 +62579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -62787,10 +62838,10 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 - '307': &452 + default: *452 + '307': &453 description: Temporary Redirect content: application/json: @@ -62819,8 +62870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -62842,7 +62893,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *452 + '307': *453 '404': *6 '409': *112 x-github: @@ -62866,11 +62917,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 - - &467 + - &468 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -62893,7 +62944,7 @@ paths: type: integer artifacts: type: array - items: &453 + items: &454 title: Artifact description: An artifact type: object @@ -62988,7 +63039,7 @@ paths: - expires_at - updated_at examples: - default: &468 + default: &469 value: total_count: 2 artifacts: @@ -63049,9 +63100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *438 - *439 - - &454 + - *440 + - &455 name: artifact_id description: The unique identifier of the artifact. in: path @@ -63063,7 +63114,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: default: value: @@ -63101,9 +63152,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *438 - *439 - - *454 + - *440 + - *455 responses: '204': description: Response @@ -63127,9 +63178,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *438 - *439 - - *454 + - *440 + - *455 - name: archive_format in: path required: true @@ -63143,7 +63194,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &624 + '410': &625 description: Gone content: application/json: @@ -63170,14 +63221,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *455 + schema: *456 examples: default: value: @@ -63203,11 +63254,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 - - &456 + - &457 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -63241,7 +63292,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &458 title: Repository actions caches description: Repository actions caches type: object @@ -63291,7 +63342,7 @@ paths: - total_count - actions_caches examples: - default: &458 + default: &459 value: total_count: 1 actions_caches: @@ -63323,23 +63374,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *438 - *439 + - *440 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *456 + - *457 responses: '200': description: Response content: application/json: - schema: *457 + schema: *458 examples: - default: *458 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63359,8 +63410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *438 - *439 + - *440 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63391,9 +63442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *438 - *439 - - &459 + - *440 + - &460 name: job_id description: The unique identifier of the job. in: path @@ -63405,7 +63456,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &472 title: Job description: Information of a job execution in a workflow run type: object @@ -63752,9 +63803,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *438 - *439 - - *459 + - *440 + - *460 responses: '302': description: Response @@ -63782,9 +63833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *438 - *439 - - *459 + - *440 + - *460 requestBody: required: false content: @@ -63830,8 +63881,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Status response @@ -63881,8 +63932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -63945,8 +63996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -63964,7 +64015,7 @@ paths: type: integer secrets: type: array - items: &473 + items: &474 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -63985,7 +64036,7 @@ paths: - created_at - updated_at examples: - default: &474 + default: &475 value: total_count: 2 secrets: @@ -64018,9 +64069,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *438 - *439 - - *460 + - *440 + - *461 - *19 responses: '200': @@ -64037,7 +64088,7 @@ paths: type: integer variables: type: array - items: &477 + items: &478 title: Actions Variable type: object properties: @@ -64071,7 +64122,7 @@ paths: - created_at - updated_at examples: - default: &478 + default: &479 value: total_count: 2 variables: @@ -64104,8 +64155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64114,7 +64165,7 @@ paths: schema: type: object properties: - enabled: &461 + enabled: &462 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *54 @@ -64149,8 +64200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -64161,7 +64212,7 @@ paths: schema: type: object properties: - enabled: *461 + enabled: *462 allowed_actions: *54 sha_pinning_required: *55 required: @@ -64194,14 +64245,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: &462 + schema: &463 type: object properties: access_level: @@ -64219,7 +64270,7 @@ paths: required: - access_level examples: - default: &463 + default: &464 value: access_level: organization x-github: @@ -64244,15 +64295,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: application/json: - schema: *462 + schema: *463 examples: - default: *463 + default: *464 responses: '204': description: Response @@ -64276,8 +64327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64307,8 +64358,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Empty response for successful settings update @@ -64342,8 +64393,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64370,8 +64421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -64405,8 +64456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64434,8 +64485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -64466,8 +64517,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64498,8 +64549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -64531,8 +64582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64561,8 +64612,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Success response @@ -64602,8 +64653,8 @@ paths: in: query schema: type: string - - *438 - *439 + - *440 - *17 - *19 responses: @@ -64647,8 +64698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -64680,8 +64731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -64755,8 +64806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *438 - *439 + - *440 responses: '201': description: Response @@ -64792,8 +64843,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *438 - *439 + - *440 responses: '201': description: Response @@ -64823,8 +64874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '200': @@ -64854,8 +64905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '204': @@ -64882,8 +64933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '200': *75 @@ -64908,8 +64959,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 requestBody: required: true @@ -64958,8 +65009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 requestBody: required: true @@ -65009,8 +65060,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 responses: '200': *270 @@ -65040,8 +65091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *438 - *439 + - *440 - *69 - *271 responses: @@ -65071,9 +65122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *438 - *439 - - &481 + - *440 + - &482 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -65081,7 +65132,7 @@ paths: required: false schema: type: string - - &482 + - &483 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -65089,7 +65140,7 @@ paths: required: false schema: type: string - - &483 + - &484 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -65098,7 +65149,7 @@ paths: required: false schema: type: string - - &484 + - &485 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -65125,7 +65176,7 @@ paths: - pending - *17 - *19 - - &485 + - &486 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -65134,7 +65185,7 @@ paths: schema: type: string format: date-time - - &464 + - &465 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -65143,13 +65194,13 @@ paths: schema: type: boolean default: false - - &486 + - &487 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &487 + - &488 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -65172,7 +65223,7 @@ paths: type: integer workflow_runs: type: array - items: &465 + items: &466 title: Workflow Run description: An invocation of a workflow type: object @@ -65289,7 +65340,7 @@ paths: type: - array - 'null' - items: &506 + items: &507 title: Pull Request Minimal type: object properties: @@ -65416,7 +65467,7 @@ paths: head_commit: anyOf: - type: 'null' - - &510 + - &511 title: Simple Commit description: A commit. type: object @@ -65531,7 +65582,7 @@ paths: - workflow_url - pull_requests examples: - default: &488 + default: &489 value: total_count: 1 workflow_runs: @@ -65767,24 +65818,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *438 - *439 - - &466 + - *440 + - &467 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *464 + - *465 responses: '200': description: Response content: application/json: - schema: *465 + schema: *466 examples: - default: &469 + default: &470 value: id: 30433642 name: Build @@ -66025,9 +66076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '204': description: Response @@ -66050,9 +66101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '200': description: Response @@ -66180,9 +66231,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '201': description: Response @@ -66215,12 +66266,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *438 - *439 - - *466 + - *440 + - *467 - *17 - *19 - - *467 + - *468 responses: '200': description: Response @@ -66236,9 +66287,9 @@ paths: type: integer artifacts: type: array - items: *453 + items: *454 examples: - default: *468 + default: *469 headers: Link: *41 x-github: @@ -66262,25 +66313,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *438 - *439 - - *466 - - &470 + - *440 + - *467 + - &471 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *464 + - *465 responses: '200': description: Response content: application/json: - schema: *465 + schema: *466 examples: - default: *469 + default: *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66303,10 +66354,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *438 - *439 - - *466 - - *470 + - *440 + - *467 + - *471 - *17 - *19 responses: @@ -66324,9 +66375,9 @@ paths: type: integer jobs: type: array - items: *471 + items: *472 examples: - default: &472 + default: &473 value: total_count: 1 jobs: @@ -66439,10 +66490,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *438 - *439 - - *466 - - *470 + - *440 + - *467 + - *471 responses: '302': description: Response @@ -66470,9 +66521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '202': description: Response @@ -66505,9 +66556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: true content: @@ -66574,9 +66625,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '202': description: Response @@ -66609,9 +66660,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -66641,9 +66692,9 @@ paths: type: integer jobs: type: array - items: *471 + items: *472 examples: - default: *472 + default: *473 headers: Link: *41 x-github: @@ -66668,9 +66719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '302': description: Response @@ -66697,9 +66748,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '204': description: Response @@ -66726,9 +66777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '200': description: Response @@ -66797,7 +66848,7 @@ paths: items: type: object properties: - type: &590 + type: &591 type: string description: The type of reviewer. enum: @@ -66883,9 +66934,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: true content: @@ -66935,7 +66986,7 @@ paths: application/json: schema: type: array - items: &576 + items: &577 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -67047,7 +67098,7 @@ paths: - created_at - updated_at examples: - default: &577 + default: &578 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -67103,9 +67154,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: false content: @@ -67150,9 +67201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *438 - *439 - - *466 + - *440 + - *467 requestBody: required: false content: @@ -67207,9 +67258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *438 - *439 - - *466 + - *440 + - *467 responses: '200': description: Response @@ -67346,8 +67397,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -67365,9 +67416,9 @@ paths: type: integer secrets: type: array - items: *473 + items: *474 examples: - default: *474 + default: *475 headers: Link: *41 x-github: @@ -67392,16 +67443,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *475 + schema: *476 examples: - default: *476 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67423,17 +67474,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '200': description: Response content: application/json: - schema: *473 + schema: *474 examples: - default: &603 + default: &604 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -67459,8 +67510,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 requestBody: required: true @@ -67518,8 +67569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '204': @@ -67545,9 +67596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *438 - *439 - - *460 + - *440 + - *461 - *19 responses: '200': @@ -67564,9 +67615,9 @@ paths: type: integer variables: type: array - items: *477 + items: *478 examples: - default: *478 + default: *479 headers: Link: *41 x-github: @@ -67589,8 +67640,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -67642,17 +67693,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *438 - *439 + - *440 - *276 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: &604 + default: &605 value: name: USERNAME value: octocat @@ -67678,8 +67729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *438 - *439 + - *440 - *276 requestBody: required: true @@ -67722,8 +67773,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *438 - *439 + - *440 - *276 responses: '204': @@ -67749,8 +67800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -67768,7 +67819,7 @@ paths: type: integer workflows: type: array - items: &479 + items: &480 title: Workflow description: A GitHub Actions workflow type: object @@ -67886,9 +67937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *438 - *439 - - &480 + - *440 + - &481 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -67903,7 +67954,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: default: value: @@ -67936,9 +67987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '204': description: Response @@ -67963,9 +68014,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '204': description: Response @@ -68016,9 +68067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '204': description: Response @@ -68045,19 +68096,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *438 - *439 - - *480 + - *440 - *481 - *482 - *483 - *484 + - *485 - *17 - *19 - - *485 - - *464 - *486 + - *465 - *487 + - *488 responses: '200': description: Response @@ -68073,9 +68124,9 @@ paths: type: integer workflow_runs: type: array - items: *465 + items: *466 examples: - default: *488 + default: *489 headers: Link: *41 x-github: @@ -68108,9 +68159,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *438 - *439 - - *480 + - *440 + - *481 responses: '200': description: Response @@ -68171,8 +68222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *438 - *439 + - *440 - *104 - *17 - *102 @@ -68340,8 +68391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -68378,8 +68429,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *438 - *439 + - *440 - name: assignee in: path required: true @@ -68415,8 +68466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -68528,8 +68579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *438 - *439 + - *440 - *17 - *102 - *103 @@ -68586,7 +68637,7 @@ paths: initiator: type: string examples: - default: *489 + default: *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68606,8 +68657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -68615,7 +68666,7 @@ paths: application/json: schema: type: array - items: &490 + items: &491 title: Autolink reference description: An autolink reference. type: object @@ -68674,8 +68725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -68714,9 +68765,9 @@ paths: description: response content: application/json: - schema: *490 + schema: *491 examples: - default: &491 + default: &492 value: id: 1 key_prefix: TICKET- @@ -68747,9 +68798,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *438 - *439 - - &492 + - *440 + - &493 name: autolink_id description: The unique identifier of the autolink. in: path @@ -68761,9 +68812,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *491 examples: - default: *491 + default: *492 '404': *6 x-github: githubCloudOnly: false @@ -68783,9 +68834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *438 - *439 - - *492 + - *440 + - *493 responses: '204': description: Response @@ -68809,8 +68860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response if Dependabot is enabled @@ -68860,8 +68911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -68882,8 +68933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -68903,8 +68954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *438 - *439 + - *440 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -68942,7 +68993,7 @@ paths: - url protected: type: boolean - protection: &494 + protection: &495 title: Branch Protection description: Branch Protection type: object @@ -68985,7 +69036,7 @@ paths: required: - contexts - checks - enforce_admins: &497 + enforce_admins: &498 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -69002,7 +69053,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &499 + required_pull_request_reviews: &500 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -69086,7 +69137,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &496 + restrictions: &497 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -69379,9 +69430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *438 - *439 - - &495 + - *440 + - &496 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -69395,14 +69446,14 @@ paths: description: Response content: application/json: - schema: &505 + schema: &506 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &552 + commit: &553 title: Commit description: Commit type: object @@ -69441,7 +69492,7 @@ paths: author: anyOf: - type: 'null' - - &493 + - &494 title: Git User description: Metaproperties for Git author/committer information. @@ -69462,7 +69513,7 @@ paths: committer: anyOf: - type: 'null' - - *493 + - *494 message: type: string examples: @@ -69486,7 +69537,7 @@ paths: required: - sha - url - verification: &610 + verification: &611 title: Verification type: object properties: @@ -69566,7 +69617,7 @@ paths: type: integer files: type: array - items: &563 + items: &564 title: Diff Entry description: Diff Entry type: object @@ -69662,7 +69713,7 @@ paths: - self protected: type: boolean - protection: *494 + protection: *495 protection_url: type: string format: uri @@ -69771,7 +69822,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *450 + '301': *451 '404': *6 x-github: githubCloudOnly: false @@ -69793,15 +69844,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *494 + schema: *495 examples: default: value: @@ -69995,9 +70046,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -70257,7 +70308,7 @@ paths: url: type: string format: uri - required_status_checks: &502 + required_status_checks: &503 title: Status Check Policy description: Status Check Policy type: object @@ -70416,7 +70467,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *496 + restrictions: *497 required_conversation_resolution: type: object properties: @@ -70528,9 +70579,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70555,17 +70606,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: &498 + default: &499 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -70587,17 +70638,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: *498 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70616,9 +70667,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70643,17 +70694,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: &500 + default: &501 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -70749,9 +70800,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -70849,9 +70900,9 @@ paths: description: Response content: application/json: - schema: *499 + schema: *500 examples: - default: *500 + default: *501 '422': *15 x-github: githubCloudOnly: false @@ -70872,9 +70923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70901,17 +70952,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: &501 + default: &502 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -70934,17 +70985,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *497 + schema: *498 examples: - default: *501 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -70964,9 +71015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -70991,17 +71042,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *502 + schema: *503 examples: - default: &503 + default: &504 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -71027,9 +71078,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71081,9 +71132,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: - default: *503 + default: *504 '404': *6 '422': *15 x-github: @@ -71105,9 +71156,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -71131,9 +71182,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71167,9 +71218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71236,9 +71287,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71302,9 +71353,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: content: application/json: @@ -71370,15 +71421,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response content: application/json: - schema: *496 + schema: *497 examples: default: value: @@ -71469,9 +71520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '204': description: Response @@ -71494,9 +71545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71506,7 +71557,7 @@ paths: type: array items: *5 examples: - default: &504 + default: &505 value: - id: 1 slug: octoapp @@ -71563,9 +71614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -71599,7 +71650,7 @@ paths: type: array items: *5 examples: - default: *504 + default: *505 '422': *15 x-github: githubCloudOnly: false @@ -71620,9 +71671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -71656,7 +71707,7 @@ paths: type: array items: *5 examples: - default: *504 + default: *505 '422': *15 x-github: githubCloudOnly: false @@ -71677,9 +71728,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -71713,7 +71764,7 @@ paths: type: array items: *5 examples: - default: *504 + default: *505 '422': *15 x-github: githubCloudOnly: false @@ -71735,9 +71786,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71767,9 +71818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71828,9 +71879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: false content: @@ -71889,9 +71940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: content: application/json: @@ -71950,9 +72001,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 responses: '200': description: Response @@ -71986,9 +72037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72046,9 +72097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72106,9 +72157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72168,9 +72219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 requestBody: required: true content: @@ -72192,7 +72243,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *506 examples: default: value: @@ -72306,8 +72357,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *438 - *439 + - *440 - *97 - *98 - *99 @@ -72343,8 +72394,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *438 - *439 + - *440 - name: bypass_request_number in: path required: true @@ -72417,8 +72468,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - *97 - *98 - *99 @@ -72458,8 +72509,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - name: bypass_request_number in: path required: true @@ -72529,8 +72580,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - name: bypass_request_number in: path required: true @@ -72601,8 +72652,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *438 - *439 + - *440 - name: bypass_response_id in: path required: true @@ -72635,8 +72686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -72915,7 +72966,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &508 title: CheckRun description: A check performed on the code of a given code change type: object @@ -73050,8 +73101,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *506 - deployment: &824 + items: *507 + deployment: &825 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -73338,9 +73389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *438 - *439 - - &508 + - *440 + - &509 name: check_run_id description: The unique identifier of the check run. in: path @@ -73352,9 +73403,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: &509 + default: &510 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -73454,9 +73505,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *438 - *439 - - *508 + - *440 + - *509 requestBody: required: true content: @@ -73696,9 +73747,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *509 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73718,9 +73769,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *438 - *439 - - *508 + - *440 + - *509 - *17 - *19 responses: @@ -73830,9 +73881,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *438 - *439 - - *508 + - *440 + - *509 responses: '201': description: Response @@ -73876,8 +73927,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -73899,7 +73950,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &511 + schema: &512 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -73981,7 +74032,7 @@ paths: type: - array - 'null' - items: *506 + items: *507 app: anyOf: - type: 'null' @@ -73997,7 +74048,7 @@ paths: - string - 'null' format: date-time - head_commit: *510 + head_commit: *511 latest_check_runs_count: type: integer check_runs_url: @@ -74025,7 +74076,7 @@ paths: - check_runs_url - pull_requests examples: - default: &512 + default: &513 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -74316,9 +74367,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *511 + schema: *512 examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74337,8 +74388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -74647,9 +74698,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *438 - *439 - - &513 + - *440 + - &514 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -74661,9 +74712,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *512 examples: - default: *512 + default: *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74686,17 +74737,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *438 - *439 - - *513 - - &558 + - *440 + - *514 + - &559 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &559 + - &560 name: status description: Returns check runs with the specified `status`. in: query @@ -74735,9 +74786,9 @@ paths: type: integer check_runs: type: array - items: *507 + items: *508 examples: - default: &560 + default: &561 value: total_count: 1 check_runs: @@ -74839,9 +74890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *438 - *439 - - *513 + - *440 + - *514 responses: '201': description: Response @@ -74874,21 +74925,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *438 - *439 + - *440 - *296 - *297 - *19 - *17 - - &529 + - &530 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *514 - - &530 + schema: *515 + - &531 name: pr description: The number of the pull request for the results you want to list. in: query @@ -74919,7 +74970,7 @@ paths: be returned. in: query required: false - schema: *515 + schema: *516 responses: '200': description: Response @@ -74935,7 +74986,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *516 + instances_url: *517 state: *107 fixed_at: *129 dismissed_by: @@ -74943,11 +74994,11 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *517 - dismissed_comment: *518 - rule: *519 - tool: *520 - most_recent_instance: *521 + dismissed_reason: *518 + dismissed_comment: *519 + rule: *520 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -75070,7 +75121,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &522 + '403': &523 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -75097,9 +75148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *438 - *439 - - &523 + - *440 + - &524 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -75113,7 +75164,7 @@ paths: description: Response content: application/json: - schema: &524 + schema: &525 type: object properties: number: *119 @@ -75121,7 +75172,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *516 + instances_url: *517 state: *107 fixed_at: *129 dismissed_by: @@ -75129,8 +75180,8 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *517 - dismissed_comment: *518 + dismissed_reason: *518 + dismissed_comment: *519 rule: type: object properties: @@ -75192,8 +75243,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *520 - most_recent_instance: *521 + tool: *521 + most_recent_instance: *522 dismissal_approved_by: anyOf: - type: 'null' @@ -75289,7 +75340,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75309,9 +75360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 requestBody: required: true content: @@ -75326,8 +75377,8 @@ paths: enum: - open - dismissed - dismissed_reason: *517 - dismissed_comment: *518 + dismissed_reason: *518 + dismissed_comment: *519 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -75346,7 +75397,7 @@ paths: description: Response content: application/json: - schema: *524 + schema: *525 examples: default: value: @@ -75422,7 +75473,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &528 + '403': &529 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -75449,15 +75500,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 responses: '200': description: Response content: application/json: - schema: &525 + schema: &526 type: object properties: status: @@ -75484,13 +75535,13 @@ paths: - description - started_at examples: - default: &526 + default: &527 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &527 + '400': &528 description: Bad Request content: application/json: @@ -75501,7 +75552,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75526,29 +75577,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 responses: '200': description: OK content: application/json: - schema: *525 + schema: *526 examples: - default: *526 + default: *527 '202': description: Accepted content: application/json: - schema: *525 + schema: *526 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *527 + '400': *528 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -75580,9 +75631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 requestBody: required: false content: @@ -75628,8 +75679,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *527 - '403': *528 + '400': *528 + '403': *529 '404': *6 '422': description: Unprocessable Entity @@ -75653,13 +75704,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 - *19 - *17 - - *529 - *530 + - *531 responses: '200': description: Response @@ -75667,7 +75718,7 @@ paths: application/json: schema: type: array - items: *521 + items: *522 examples: default: value: @@ -75706,7 +75757,7 @@ paths: end_column: 50 classifications: - source - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75740,25 +75791,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *438 - *439 + - *440 - *296 - *297 - *19 - *17 - - *530 + - *531 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *514 + schema: *515 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &533 + schema: &534 type: string description: An identifier for the upload. examples: @@ -75780,23 +75831,23 @@ paths: application/json: schema: type: array - items: &534 + items: &535 type: object properties: - ref: *514 - commit_sha: &542 + ref: *515 + commit_sha: &543 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *531 + analysis_key: *532 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *532 + category: *533 error: type: string examples: @@ -75821,8 +75872,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *533 - tool: *520 + sarif_id: *534 + tool: *521 deletable: type: boolean warning: @@ -75884,7 +75935,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -75920,8 +75971,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *438 - *439 + - *440 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75934,7 +75985,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *535 examples: response: summary: application/json response @@ -75988,7 +76039,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *522 + '403': *523 '404': *6 '422': description: Response if analysis could not be processed @@ -76075,8 +76126,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *438 - *439 + - *440 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -76132,7 +76183,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *528 + '403': *529 '404': *6 '503': *184 x-github: @@ -76154,8 +76205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -76163,7 +76214,7 @@ paths: application/json: schema: type: array - items: &535 + items: &536 title: CodeQL Database description: A CodeQL database. type: object @@ -76275,7 +76326,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -76304,8 +76355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *438 - *439 + - *440 - name: language in: path description: The language of the CodeQL database. @@ -76317,7 +76368,7 @@ paths: description: Response content: application/json: - schema: *535 + schema: *536 examples: default: value: @@ -76349,9 +76400,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &565 + '302': &566 description: Found - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -76373,8 +76424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *438 - *439 + - *440 - name: language in: path description: The language of the CodeQL database. @@ -76384,7 +76435,7 @@ paths: responses: '204': description: Response - '403': *528 + '403': *529 '404': *6 '503': *184 x-github: @@ -76412,8 +76463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -76422,7 +76473,7 @@ paths: type: object additionalProperties: false properties: - language: &536 + language: &537 type: string description: The language targeted by the CodeQL query enum: @@ -76502,7 +76553,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &540 + schema: &541 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -76512,7 +76563,7 @@ paths: description: The ID of the variant analysis. controller_repo: *113 actor: *4 - query_language: *536 + query_language: *537 query_pack_url: type: string description: The download url for the query pack. @@ -76560,7 +76611,7 @@ paths: items: type: object properties: - repository: &537 + repository: &538 title: Repository Identifier description: Repository Identifier type: object @@ -76602,7 +76653,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &541 + analysis_status: &542 type: string description: The new status of the CodeQL variant analysis repository task. @@ -76634,7 +76685,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &538 + access_mismatch_repos: &539 type: object properties: repository_count: @@ -76649,7 +76700,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *537 + items: *538 required: - repository_count - repositories @@ -76672,8 +76723,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *538 - over_limit_repos: *538 + no_codeql_db_repos: *539 + over_limit_repos: *539 required: - access_mismatch_repos - not_found_repos @@ -76689,7 +76740,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &539 + value: &540 summary: Default response value: id: 1 @@ -76841,10 +76892,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *539 + value: *540 repository_lists: summary: Response for a successful variant analysis submission - value: *539 + value: *540 '404': *6 '422': description: Unable to process variant analysis submission @@ -76872,8 +76923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *438 - *439 + - *440 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -76885,9 +76936,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *541 examples: - default: *539 + default: *540 '404': *6 '503': *184 x-github: @@ -76910,7 +76961,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *438 + - *439 - name: repo in: path description: The name of the controller repository. @@ -76945,7 +76996,7 @@ paths: type: object properties: repository: *113 - analysis_status: *541 + analysis_status: *542 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -77070,8 +77121,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -77164,7 +77215,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *522 + '403': *523 '404': *6 '503': *184 x-github: @@ -77185,8 +77236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -77280,7 +77331,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *528 + '403': *529 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -77351,8 +77402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -77360,7 +77411,7 @@ paths: schema: type: object properties: - commit_sha: *542 + commit_sha: *543 ref: type: string description: |- @@ -77420,7 +77471,7 @@ paths: schema: type: object properties: - id: *533 + id: *534 url: type: string description: The REST API URL for checking the status of the upload. @@ -77434,7 +77485,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *528 + '403': *529 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -77457,8 +77508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *438 - *439 + - *440 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -77506,7 +77557,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *522 + '403': *523 '404': description: Not Found if the sarif id does not match any upload '503': *184 @@ -77531,8 +77582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -77613,8 +77664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *438 - *439 + - *440 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -77742,8 +77793,8 @@ paths: parameters: - *17 - *19 - - *438 - *439 + - *440 responses: '200': description: Response @@ -78057,8 +78108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -78124,7 +78175,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -78132,7 +78183,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '400': *14 '401': *23 '403': *27 @@ -78161,8 +78212,8 @@ paths: parameters: - *17 - *19 - - *438 - *439 + - *440 responses: '200': description: Response @@ -78226,8 +78277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *438 - *439 + - *440 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -78264,9 +78315,9 @@ paths: type: integer machines: type: array - items: *544 + items: *545 examples: - default: &782 + default: &783 value: total_count: 2 machines: @@ -78306,8 +78357,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *438 - *439 + - *440 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -78394,8 +78445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *438 - *439 + - *440 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -78464,8 +78515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -78483,7 +78534,7 @@ paths: type: integer secrets: type: array - items: &548 + items: &549 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -78504,7 +78555,7 @@ paths: - created_at - updated_at examples: - default: *545 + default: *546 headers: Link: *41 x-github: @@ -78527,16 +78578,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *546 + schema: *547 examples: - default: *547 + default: *548 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78556,17 +78607,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '200': description: Response content: application/json: - schema: *548 + schema: *549 examples: - default: *549 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78586,8 +78637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 requestBody: required: true @@ -78640,8 +78691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '204': @@ -78670,8 +78721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *438 - *439 + - *440 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -78709,7 +78760,7 @@ paths: application/json: schema: type: array - items: &550 + items: &551 title: Collaborator description: Collaborator type: object @@ -78902,8 +78953,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *438 - *439 + - *440 - *132 responses: '204': @@ -78950,8 +79001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *438 - *439 + - *440 - *132 requestBody: required: false @@ -78978,7 +79029,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &623 + schema: &624 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -79206,8 +79257,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *438 - *439 + - *440 - *132 responses: '204': @@ -79239,8 +79290,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *438 - *439 + - *440 - *132 responses: '200': @@ -79261,7 +79312,7 @@ paths: user: anyOf: - type: 'null' - - *550 + - *551 required: - permission - role_name @@ -79315,8 +79366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -79326,7 +79377,7 @@ paths: application/json: schema: type: array - items: &551 + items: &552 title: Commit Comment description: Commit Comment type: object @@ -79384,7 +79435,7 @@ paths: - created_at - updated_at examples: - default: &554 + default: &555 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79443,17 +79494,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 responses: '200': description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: &555 + default: &556 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79510,8 +79561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -79534,7 +79585,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *552 examples: default: value: @@ -79585,8 +79636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 responses: '204': @@ -79608,8 +79659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -79636,9 +79687,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -79659,8 +79710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -79693,16 +79744,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -79724,10 +79775,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *438 - *439 + - *440 - *218 - - *430 + - *431 responses: '204': description: Response @@ -79776,8 +79827,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *438 - *439 + - *440 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -79833,9 +79884,9 @@ paths: application/json: schema: type: array - items: *552 + items: *553 examples: - default: &673 + default: &674 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -79929,9 +79980,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *438 - *439 - - &553 + - *440 + - &554 name: commit_sha description: The SHA of the commit. in: path @@ -80003,9 +80054,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *438 - *439 - - *553 + - *440 + - *554 - *17 - *19 responses: @@ -80015,9 +80066,9 @@ paths: application/json: schema: type: array - items: *551 + items: *552 examples: - default: *554 + default: *555 headers: Link: *41 x-github: @@ -80045,9 +80096,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *438 - *439 - - *553 + - *440 + - *554 requestBody: required: true content: @@ -80082,9 +80133,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *552 examples: - default: *555 + default: *556 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -80112,9 +80163,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *438 - *439 - - *553 + - *440 + - *554 - *17 - *19 responses: @@ -80124,9 +80175,9 @@ paths: application/json: schema: type: array - items: *556 + items: *557 examples: - default: &665 + default: &666 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -80663,11 +80714,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *438 - *439 + - *440 - *19 - *17 - - &557 + - &558 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -80682,9 +80733,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *553 examples: - default: &651 + default: &652 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -80797,11 +80848,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *438 - *439 - - *557 + - *440 - *558 - *559 + - *560 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -80835,9 +80886,9 @@ paths: type: integer check_runs: type: array - items: *507 + items: *508 examples: - default: *560 + default: *561 headers: Link: *41 x-github: @@ -80862,9 +80913,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *438 - *439 - - *557 + - *440 + - *558 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -80872,7 +80923,7 @@ paths: schema: type: integer example: 1 - - *558 + - *559 - *17 - *19 responses: @@ -80890,7 +80941,7 @@ paths: type: integer check_suites: type: array - items: *511 + items: *512 examples: default: value: @@ -81090,9 +81141,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *438 - *439 - - *557 + - *440 + - *558 - *17 - *19 responses: @@ -81294,9 +81345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *438 - *439 - - *557 + - *440 + - *558 - *17 - *19 responses: @@ -81306,7 +81357,7 @@ paths: application/json: schema: type: array - items: &727 + items: &728 title: Status description: The status of a commit. type: object @@ -81387,7 +81438,7 @@ paths: site_admin: false headers: Link: *41 - '301': *450 + '301': *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81415,8 +81466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -81449,11 +81500,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *561 + - *562 code_of_conduct_file: anyOf: - type: 'null' - - &562 + - &563 title: Community Health File type: object properties: @@ -81473,19 +81524,19 @@ paths: contributing: anyOf: - type: 'null' - - *562 + - *563 readme: anyOf: - type: 'null' - - *562 + - *563 issue_template: anyOf: - type: 'null' - - *562 + - *563 pull_request_template: anyOf: - type: 'null' - - *562 + - *563 required: - code_of_conduct - code_of_conduct_file @@ -81614,8 +81665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *438 - *439 + - *440 - *19 - *17 - name: basehead @@ -81663,8 +81714,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *552 - merge_base_commit: *552 + base_commit: *553 + merge_base_commit: *553 status: type: string enum: @@ -81688,10 +81739,10 @@ paths: - 6 commits: type: array - items: *552 + items: *553 files: type: array - items: *563 + items: *564 required: - url - html_url @@ -81977,8 +82028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *438 - *439 + - *440 - name: path description: path parameter in: path @@ -82131,7 +82182,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &564 + response-if-content-is-a-file: &565 summary: Response if content is a file value: type: file @@ -82268,7 +82319,7 @@ paths: - size - type - url - - &678 + - &679 title: Content File description: Content File type: object @@ -82486,7 +82537,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *564 + response-if-content-is-a-file: *565 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -82555,7 +82606,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *565 + '302': *566 '304': *35 x-github: githubCloudOnly: false @@ -82578,8 +82629,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *438 - *439 + - *440 - name: path description: path parameter in: path @@ -82674,7 +82725,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &567 title: File Commit description: File Commit type: object @@ -82830,7 +82881,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: example-for-creating-a-file: value: @@ -82884,7 +82935,7 @@ paths: schema: oneOf: - *3 - - &605 + - &606 description: Repository rule violation was detected type: object properties: @@ -82905,7 +82956,7 @@ paths: items: type: object properties: - placeholder_id: &719 + placeholder_id: &720 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -82937,8 +82988,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *438 - *439 + - *440 - name: path description: path parameter in: path @@ -82999,7 +83050,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -83054,8 +83105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *438 - *439 + - *440 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -83179,8 +83230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *438 - *439 + - *440 - *312 - *313 - *314 @@ -83192,7 +83243,7 @@ paths: schema: type: string - *316 - - *567 + - *568 - *317 - *318 - *104 @@ -83213,7 +83264,7 @@ paths: application/json: schema: type: array - items: &570 + items: &571 type: object description: A Dependabot alert. properties: @@ -83263,7 +83314,7 @@ paths: - direct - transitive - - security_advisory: *568 + security_advisory: *569 security_vulnerability: *123 url: *124 html_url: *125 @@ -83294,7 +83345,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: *569 + auto_dismissed_at: *570 required: - number - state @@ -83524,9 +83575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *438 - *439 - - &571 + - *440 + - &572 name: alert_number in: path description: |- @@ -83541,7 +83592,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *571 examples: default: value: @@ -83654,9 +83705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *438 - *439 - - *571 + - *440 + - *572 requestBody: required: true content: @@ -83701,7 +83752,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *571 examples: default: value: @@ -83830,8 +83881,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -83849,7 +83900,7 @@ paths: type: integer secrets: type: array - items: &574 + items: &575 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -83903,16 +83954,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *572 + schema: *573 examples: - default: *573 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83932,15 +83983,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '200': description: Response content: application/json: - schema: *574 + schema: *575 examples: default: value: @@ -83966,8 +84017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 requestBody: required: true @@ -84020,8 +84071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *438 - *439 + - *440 - *273 responses: '204': @@ -84044,8 +84095,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *438 - *439 + - *440 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -84219,8 +84270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -84480,8 +84531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -84564,7 +84615,7 @@ paths: - version - url additionalProperties: false - metadata: &575 + metadata: &576 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -84603,7 +84654,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *575 + metadata: *576 resolved: type: object description: A collection of resolved package dependencies. @@ -84617,7 +84668,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *575 + metadata: *576 relationship: type: string description: A notation of whether a dependency is requested @@ -84750,8 +84801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *438 - *439 + - *440 - name: sha description: The SHA recorded at creation time. in: query @@ -84792,9 +84843,9 @@ paths: application/json: schema: type: array - items: *576 + items: *577 examples: - default: *577 + default: *578 headers: Link: *41 x-github: @@ -84860,8 +84911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -84943,7 +84994,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: simple-example: summary: Simple example @@ -85016,9 +85067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *438 - *439 - - &578 + - *440 + - &579 name: deployment_id description: deployment_id parameter in: path @@ -85030,7 +85081,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *577 examples: default: value: @@ -85095,9 +85146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *438 - *439 - - *578 + - *440 + - *579 responses: '204': description: Response @@ -85119,9 +85170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *438 - *439 - - *578 + - *440 + - *579 - *17 - *19 responses: @@ -85131,7 +85182,7 @@ paths: application/json: schema: type: array - items: &579 + items: &580 title: Deployment Status description: The status of a deployment. type: object @@ -85295,9 +85346,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *438 - *439 - - *578 + - *440 + - *579 requestBody: required: true content: @@ -85372,9 +85423,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: &580 + default: &581 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -85430,9 +85481,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *438 - *439 - - *578 + - *440 + - *579 - name: status_id in: path required: true @@ -85443,9 +85494,9 @@ paths: description: Response content: application/json: - schema: *579 + schema: *580 examples: - default: *580 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -85472,12 +85523,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 - - *581 + - *440 - *582 - *583 - *584 + - *585 - *17 - *19 responses: @@ -85487,9 +85538,9 @@ paths: application/json: schema: type: array - items: *585 + items: *586 examples: - default: *586 + default: *587 '404': *6 '403': *27 '500': *38 @@ -85513,8 +85564,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85526,7 +85577,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *585 + schema: *586 examples: default: value: @@ -85582,8 +85633,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85642,12 +85693,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - *97 - *98 - *99 - - *587 + - *588 - *17 - *19 responses: @@ -85657,9 +85708,9 @@ paths: application/json: schema: type: array - items: *588 + items: *589 examples: - default: *589 + default: *590 '404': *6 '403': *27 '500': *38 @@ -85684,8 +85735,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85697,7 +85748,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *588 + schema: *589 examples: default: value: @@ -85755,8 +85806,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *438 - *439 + - *440 - name: alert_number in: path required: true @@ -85825,8 +85876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -85883,8 +85934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -85902,7 +85953,7 @@ paths: - 5 environments: type: array - items: &591 + items: &592 title: Environment description: Details of a deployment environment type: object @@ -85964,7 +86015,7 @@ paths: type: string examples: - wait_timer - wait_timer: &593 + wait_timer: &594 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -86006,7 +86057,7 @@ paths: items: type: object properties: - type: *590 + type: *591 reviewer: anyOf: - *4 @@ -86033,7 +86084,7 @@ paths: - id - node_id - type - deployment_branch_policy: &594 + deployment_branch_policy: &595 type: - object - 'null' @@ -86150,9 +86201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *438 - *439 - - &592 + - *440 + - &593 name: environment_name in: path required: true @@ -86165,9 +86216,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: &595 + default: &596 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -86251,9 +86302,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *438 - *439 - - *592 + - *440 + - *593 requestBody: required: false content: @@ -86263,7 +86314,7 @@ paths: - object - 'null' properties: - wait_timer: *593 + wait_timer: *594 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -86282,14 +86333,14 @@ paths: items: type: object properties: - type: *590 + type: *591 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *594 + deployment_branch_policy: *595 additionalProperties: false examples: default: @@ -86309,9 +86360,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: *595 + default: *596 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -86335,9 +86386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *438 - *439 - - *592 + - *440 + - *593 responses: '204': description: Default response @@ -86362,9 +86413,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *17 - *19 responses: @@ -86383,7 +86434,7 @@ paths: - 2 branch_policies: type: array - items: &596 + items: &597 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -86444,9 +86495,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 + - *440 + - *593 requestBody: required: true content: @@ -86494,9 +86545,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - example-wildcard: &597 + example-wildcard: &598 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -86538,10 +86589,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 - - &598 + - *440 + - *593 + - &599 name: branch_policy_id in: path required: true @@ -86553,9 +86604,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86574,10 +86625,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 - - *598 + - *440 + - *593 + - *599 requestBody: required: true content: @@ -86606,9 +86657,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *597 examples: - default: *597 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86627,10 +86678,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *438 - *439 - - *592 - - *598 + - *440 + - *593 + - *599 responses: '204': description: Response @@ -86655,9 +86706,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 responses: '200': description: List of deployment protection rules @@ -86674,7 +86725,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &599 + items: &600 title: Deployment protection rule description: Deployment protection rule type: object @@ -86696,7 +86747,7 @@ paths: for the environment. examples: - true - app: &600 + app: &601 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -86799,9 +86850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 requestBody: content: application/json: @@ -86822,9 +86873,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *599 + schema: *600 examples: - default: &601 + default: &602 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -86859,9 +86910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 - *19 - *17 responses: @@ -86881,7 +86932,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *600 + items: *601 examples: default: value: @@ -86916,10 +86967,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *438 - *439 - - *592 - - &602 + - *440 + - *593 + - &603 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -86931,9 +86982,9 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: - default: *601 + default: *602 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86954,10 +87005,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *592 + - *593 + - *440 - *439 - - *438 - - *602 + - *603 responses: '204': description: Response @@ -86983,9 +87034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *17 - *19 responses: @@ -87003,9 +87054,9 @@ paths: type: integer secrets: type: array - items: *473 + items: *474 examples: - default: *474 + default: *475 headers: Link: *41 x-github: @@ -87030,17 +87081,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *438 - *439 - - *592 + - *440 + - *593 responses: '200': description: Response content: application/json: - schema: *475 + schema: *476 examples: - default: *476 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87062,18 +87113,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *273 responses: '200': description: Response content: application/json: - schema: *473 + schema: *474 examples: - default: *603 + default: *604 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87095,9 +87146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *273 requestBody: required: true @@ -87155,9 +87206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *273 responses: '204': @@ -87183,10 +87234,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *438 - *439 - - *592 - - *460 + - *440 + - *593 + - *461 - *19 responses: '200': @@ -87203,9 +87254,9 @@ paths: type: integer variables: type: array - items: *477 + items: *478 examples: - default: *478 + default: *479 headers: Link: *41 x-github: @@ -87228,9 +87279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *438 - *439 - - *592 + - *440 + - *593 requestBody: required: true content: @@ -87282,18 +87333,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *438 - *439 - - *592 + - *440 + - *593 - *276 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: *604 + default: *605 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87314,10 +87365,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *438 - *439 + - *440 - *276 - - *592 + - *593 requestBody: required: true content: @@ -87359,10 +87410,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *438 - *439 + - *440 - *276 - - *592 + - *593 responses: '204': description: Response @@ -87384,8 +87435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -87453,8 +87504,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *438 - *439 + - *440 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -87613,8 +87664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -87647,9 +87698,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 '400': *14 '422': *15 '403': *27 @@ -87670,8 +87721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -87731,7 +87782,7 @@ paths: schema: oneOf: - *238 - - *605 + - *606 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87756,8 +87807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *438 - *439 + - *440 - name: file_sha in: path required: true @@ -87857,8 +87908,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -87967,7 +88018,7 @@ paths: description: Response content: application/json: - schema: &606 + schema: &607 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -88194,15 +88245,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *438 - *439 - - *553 + - *440 + - *554 responses: '200': description: Response content: application/json: - schema: *606 + schema: *607 examples: default: value: @@ -88258,9 +88309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *438 - *439 - - &607 + - *440 + - &608 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -88277,7 +88328,7 @@ paths: application/json: schema: type: array - items: &608 + items: &609 title: Git Reference description: Git references within a repository type: object @@ -88353,17 +88404,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *438 - *439 - - *607 + - *440 + - *608 responses: '200': description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: &609 + default: &610 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -88392,8 +88443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -88422,9 +88473,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -88450,9 +88501,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *438 - *439 - - *607 + - *440 + - *608 requestBody: required: true content: @@ -88481,9 +88532,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 '422': *15 '409': *112 x-github: @@ -88501,9 +88552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *438 - *439 - - *607 + - *440 + - *608 responses: '204': description: Response @@ -88558,8 +88609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -88626,7 +88677,7 @@ paths: description: Response content: application/json: - schema: &611 + schema: &612 title: Git Tag description: Metadata for a Git tag type: object @@ -88682,7 +88733,7 @@ paths: - sha - type - url - verification: *610 + verification: *611 required: - sha - url @@ -88692,7 +88743,7 @@ paths: - tag - message examples: - default: &612 + default: &613 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -88765,8 +88816,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *438 - *439 + - *440 - name: tag_sha in: path required: true @@ -88777,9 +88828,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *612 + default: *613 '404': *6 '409': *112 x-github: @@ -88803,8 +88854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -88878,7 +88929,7 @@ paths: description: Response content: application/json: - schema: &613 + schema: &614 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -88980,8 +89031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *438 - *439 + - *440 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -89004,7 +89055,7 @@ paths: description: Response content: application/json: - schema: *613 + schema: *614 examples: default-response: summary: Default response @@ -89063,8 +89114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -89074,7 +89125,7 @@ paths: application/json: schema: type: array - items: &614 + items: &615 title: Webhook description: Webhooks for repositories. type: object @@ -89137,7 +89188,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &860 + last_response: &861 title: Hook Response type: object properties: @@ -89214,8 +89265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -89268,9 +89319,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: &615 + default: &616 value: type: Repository id: 12345678 @@ -89318,17 +89369,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '200': description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '404': *6 x-github: githubCloudOnly: false @@ -89348,8 +89399,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 requestBody: required: true @@ -89395,9 +89446,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '422': *15 '404': *6 x-github: @@ -89418,8 +89469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '204': @@ -89444,8 +89495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *438 - *439 + - *440 - *324 responses: '200': @@ -89473,8 +89524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *438 - *439 + - *440 - *324 requestBody: required: false @@ -89519,8 +89570,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 - *17 - *325 @@ -89552,8 +89603,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 - *16 responses: @@ -89582,8 +89633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 - *16 responses: @@ -89607,8 +89658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '204': @@ -89634,8 +89685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *438 - *439 + - *440 - *324 responses: '204': @@ -89659,8 +89710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response if immutable releases are enabled @@ -89708,8 +89759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *438 - *439 + - *440 responses: '204': *144 '409': *112 @@ -89729,8 +89780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *438 - *439 + - *440 responses: '204': *144 '409': *112 @@ -89787,14 +89838,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: &616 + schema: &617 title: Import description: A repository import from an external source. type: object @@ -89901,7 +89952,7 @@ paths: - html_url - authors_url examples: - default: &619 + default: &620 value: vcs: subversion use_lfs: true @@ -89917,7 +89968,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &617 + '503': &618 description: Unavailable due to service under maintenance. content: application/json: @@ -89946,8 +89997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -89995,7 +90046,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: default: value: @@ -90020,7 +90071,7 @@ paths: type: string '422': *15 '404': *6 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90048,8 +90099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -90101,7 +90152,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: example-1: summary: Example 1 @@ -90149,7 +90200,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90172,12 +90223,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *438 - *439 + - *440 responses: '204': description: Response - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90203,9 +90254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *438 - *439 - - &803 + - *440 + - &804 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -90219,7 +90270,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 title: Porter Author description: Porter Author type: object @@ -90273,7 +90324,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90298,8 +90349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *438 - *439 + - *440 - name: author_id in: path required: true @@ -90329,7 +90380,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -90342,7 +90393,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90366,8 +90417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -90408,7 +90459,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90436,8 +90487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -90464,11 +90515,11 @@ paths: description: Response content: application/json: - schema: *616 + schema: *617 examples: - default: *619 + default: *620 '422': *15 - '503': *617 + '503': *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90491,8 +90542,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -90500,8 +90551,8 @@ paths: application/json: schema: *20 examples: - default: *620 - '301': *450 + default: *621 + '301': *451 '404': *6 x-github: githubCloudOnly: false @@ -90521,8 +90572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -90535,7 +90586,7 @@ paths: properties: {} additionalProperties: false examples: - default: &622 + default: &623 value: limit: collaborators_only origin: repository @@ -90560,13 +90611,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: application/json: - schema: *621 + schema: *622 examples: default: summary: Example request body @@ -90580,7 +90631,7 @@ paths: application/json: schema: *342 examples: - default: *622 + default: *623 '409': description: Response x-github: @@ -90602,8 +90653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -90626,8 +90677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -90637,9 +90688,9 @@ paths: application/json: schema: type: array - items: *623 + items: *624 examples: - default: &796 + default: &797 value: - id: 1 repository: @@ -90770,8 +90821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *438 - *439 + - *440 - *346 requestBody: required: false @@ -90801,7 +90852,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *624 examples: default: value: @@ -90932,8 +90983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *438 - *439 + - *440 - *346 responses: '204': @@ -90965,8 +91016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *438 - *439 + - *440 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -91039,7 +91090,7 @@ paths: type: array items: *219 examples: - default: &631 + default: &632 value: - id: 1 node_id: MDU6SXNzdWUx @@ -91187,7 +91238,7 @@ paths: state_reason: completed headers: Link: *41 - '301': *450 + '301': *451 '422': *15 '404': *6 x-github: @@ -91216,8 +91267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -91309,7 +91360,7 @@ paths: application/json: schema: *219 examples: - default: &628 + default: &629 value: id: 1 node_id: MDU6SXNzdWUx @@ -91465,7 +91516,7 @@ paths: '422': *15 '503': *184 '404': *6 - '410': *624 + '410': *625 x-github: triggersNotification: true githubCloudOnly: false @@ -91493,8 +91544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *438 - *439 + - *440 - *228 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -91515,9 +91566,9 @@ paths: application/json: schema: type: array - items: *625 + items: *626 examples: - default: &630 + default: &631 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91575,17 +91626,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 responses: '200': description: Response content: application/json: - schema: *625 + schema: *626 examples: - default: &626 + default: &627 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91639,8 +91690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -91663,9 +91714,9 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: - default: *626 + default: *627 '422': *15 x-github: githubCloudOnly: false @@ -91683,8 +91734,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 responses: '204': @@ -91705,8 +91756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -91733,9 +91784,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -91756,8 +91807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -91790,16 +91841,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -91821,10 +91872,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *438 - *439 + - *440 - *218 - - *430 + - *431 responses: '204': description: Response @@ -91844,8 +91895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -91855,7 +91906,7 @@ paths: application/json: schema: type: array - items: &627 + items: &628 title: Issue Event description: Issue Event type: object @@ -92194,8 +92245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *438 - *439 + - *440 - name: event_id in: path required: true @@ -92206,7 +92257,7 @@ paths: description: Response content: application/json: - schema: *627 + schema: *628 examples: default: value: @@ -92399,7 +92450,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *624 + '410': *625 '403': *27 x-github: githubCloudOnly: false @@ -92433,9 +92484,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *438 - *439 - - &629 + - *440 + - &630 name: issue_number description: The number that identifies the issue. in: path @@ -92449,10 +92500,10 @@ paths: application/json: schema: *219 examples: - default: *628 - '301': *450 + default: *629 + '301': *451 '404': *6 - '410': *624 + '410': *625 '304': *35 x-github: githubCloudOnly: false @@ -92477,9 +92528,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -92600,13 +92651,13 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 '422': *15 '503': *184 '403': *27 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92624,9 +92675,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -92654,7 +92705,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92670,9 +92721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: content: application/json: @@ -92699,7 +92750,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92721,9 +92772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: assignee in: path required: true @@ -92763,9 +92814,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *209 - *17 - *19 @@ -92776,13 +92827,13 @@ paths: application/json: schema: type: array - items: *625 + items: *626 examples: - default: *630 + default: *631 headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92811,9 +92862,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -92835,16 +92886,16 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: - default: *626 + default: *627 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *624 + '410': *625 '422': *15 '404': *6 x-github: @@ -92872,9 +92923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -92886,12 +92937,12 @@ paths: type: array items: *219 examples: - default: *631 + default: *632 headers: Link: *41 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92919,9 +92970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -92945,15 +92996,15 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *450 + '301': *451 '403': *27 - '410': *624 + '410': *625 '422': *15 '404': *6 x-github: @@ -92984,9 +93035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -93000,13 +93051,13 @@ paths: application/json: schema: *219 examples: - default: *628 - '301': *450 + default: *629 + '301': *451 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *624 + '410': *625 x-github: triggersNotification: true githubCloudOnly: false @@ -93032,9 +93083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -93046,12 +93097,12 @@ paths: type: array items: *219 examples: - default: *631 + default: *632 headers: Link: *41 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93068,9 +93119,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -93084,7 +93135,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &634 + - &635 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -93133,7 +93184,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &635 + - &636 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -93261,7 +93312,7 @@ paths: - performed_via_github_app - assignee - assigner - - &636 + - &637 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -93307,7 +93358,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &637 + - &638 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -93353,7 +93404,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &638 + - &639 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -93402,7 +93453,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &639 + - &640 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -93444,7 +93495,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &640 + - &641 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -93486,7 +93537,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &641 + - &642 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -93542,7 +93593,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &642 + - &643 title: Locked Issue Event description: Locked Issue Event type: object @@ -93587,7 +93638,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &643 + - &644 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -93648,7 +93699,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &644 + - &645 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -93709,7 +93760,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &645 + - &646 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -93770,7 +93821,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &646 + - &647 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -93863,7 +93914,7 @@ paths: color: red headers: Link: *41 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93880,9 +93931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -93892,7 +93943,7 @@ paths: application/json: schema: type: array - items: &632 + items: &633 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -93947,7 +93998,7 @@ paths: - color - default examples: - default: &633 + default: &634 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93965,9 +94016,9 @@ paths: default: false headers: Link: *41 - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93984,9 +94035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -94045,12 +94096,12 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 - '301': *450 + default: *634 + '301': *451 '404': *6 - '410': *624 + '410': *625 '422': *15 x-github: githubCloudOnly: false @@ -94067,9 +94118,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -94129,12 +94180,12 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 - '301': *450 + default: *634 + '301': *451 '404': *6 - '410': *624 + '410': *625 '422': *15 x-github: githubCloudOnly: false @@ -94151,15 +94202,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 responses: '204': description: Response - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94178,9 +94229,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: name in: path required: true @@ -94193,7 +94244,7 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: default: value: @@ -94204,9 +94255,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *450 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94226,9 +94277,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: false content: @@ -94257,7 +94308,7 @@ paths: '204': description: Response '403': *27 - '410': *624 + '410': *625 '404': *6 '422': *15 x-github: @@ -94275,9 +94326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 responses: '204': description: Response @@ -94307,9 +94358,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 responses: '200': description: Response @@ -94317,10 +94368,10 @@ paths: application/json: schema: *219 examples: - default: *628 - '301': *450 + default: *629 + '301': *451 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94337,9 +94388,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -94365,13 +94416,13 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94389,9 +94440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94423,16 +94474,16 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -94454,10 +94505,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *438 - *439 - - *629 - - *430 + - *440 + - *630 + - *431 responses: '204': description: Response @@ -94486,9 +94537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94512,7 +94563,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -94545,9 +94596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -94559,11 +94610,11 @@ paths: type: array items: *219 examples: - default: *631 + default: *632 headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94591,9 +94642,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94622,14 +94673,14 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *624 + '410': *625 '422': *15 '404': *6 x-github: @@ -94649,9 +94700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 requestBody: required: true content: @@ -94684,7 +94735,7 @@ paths: application/json: schema: *219 examples: - default: *628 + default: *629 '403': *27 '404': *6 '422': *7 @@ -94706,9 +94757,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *438 - *439 - - *629 + - *440 + - *630 - *17 - *19 responses: @@ -94723,7 +94774,6 @@ paths: description: Timeline Event type: object anyOf: - - *634 - *635 - *636 - *637 @@ -94736,6 +94786,7 @@ paths: - *644 - *645 - *646 + - *647 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -95064,7 +95115,7 @@ paths: type: string comments: type: array - items: &667 + items: &668 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -95302,7 +95353,7 @@ paths: type: string comments: type: array - items: *551 + items: *552 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -95577,7 +95628,7 @@ paths: headers: Link: *41 '404': *6 - '410': *624 + '410': *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95594,8 +95645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -95605,7 +95656,7 @@ paths: application/json: schema: type: array - items: &647 + items: &648 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -95673,8 +95724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -95710,9 +95761,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: &648 + default: &649 value: id: 1 key: ssh-rsa AAA... @@ -95746,9 +95797,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *438 - *439 - - &649 + - *440 + - &650 name: key_id description: The unique identifier of the key. in: path @@ -95760,9 +95811,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *648 examples: - default: *648 + default: *649 '404': *6 x-github: githubCloudOnly: false @@ -95780,9 +95831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *438 - *439 - - *649 + - *440 + - *650 responses: '204': description: Response @@ -95802,8 +95853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -95813,9 +95864,9 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 + default: *634 headers: Link: *41 '404': *6 @@ -95836,8 +95887,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -95873,9 +95924,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *633 examples: - default: &650 + default: &651 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -95907,8 +95958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *438 - *439 + - *440 - name: name in: path required: true @@ -95919,9 +95970,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *633 examples: - default: *650 + default: *651 '404': *6 x-github: githubCloudOnly: false @@ -95938,8 +95989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *438 - *439 + - *440 - name: name in: path required: true @@ -95978,7 +96029,7 @@ paths: description: Response content: application/json: - schema: *632 + schema: *633 examples: default: value: @@ -96004,8 +96055,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *438 - *439 + - *440 - name: name in: path required: true @@ -96031,8 +96082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -96068,8 +96119,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *438 - *439 + - *440 responses: '202': *37 '403': @@ -96097,8 +96148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -96124,9 +96175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *438 - *439 - - *529 + - *440 + - *530 responses: '200': description: Response @@ -96273,8 +96324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -96339,8 +96390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -96374,9 +96425,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *552 + schema: *553 examples: - default: *651 + default: *652 '204': description: Response when already merged '404': @@ -96401,8 +96452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *438 - *439 + - *440 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -96499,8 +96550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -96542,7 +96593,7 @@ paths: application/json: schema: *381 examples: - default: &652 + default: &653 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -96601,9 +96652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *438 - *439 - - &653 + - *440 + - &654 name: milestone_number description: The number that identifies the milestone. in: path @@ -96617,7 +96668,7 @@ paths: application/json: schema: *381 examples: - default: *652 + default: *653 '404': *6 x-github: githubCloudOnly: false @@ -96634,9 +96685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *438 - *439 - - *653 + - *440 + - *654 requestBody: required: false content: @@ -96676,7 +96727,7 @@ paths: application/json: schema: *381 examples: - default: *652 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96692,9 +96743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *438 - *439 - - *653 + - *440 + - *654 responses: '204': description: Response @@ -96715,9 +96766,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *438 - *439 - - *653 + - *440 + - *654 - *17 - *19 responses: @@ -96727,9 +96778,9 @@ paths: application/json: schema: type: array - items: *632 + items: *633 examples: - default: *633 + default: *634 headers: Link: *41 x-github: @@ -96748,12 +96799,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *438 - *439 - - *654 + - *440 - *655 - - *209 - *656 + - *209 + - *657 - *17 - *19 responses: @@ -96765,7 +96816,7 @@ paths: type: array items: *231 examples: - default: *657 + default: *658 headers: Link: *41 x-github: @@ -96789,8 +96840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -96848,14 +96899,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: &658 + schema: &659 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -96999,7 +97050,7 @@ paths: - custom_404 - public examples: - default: &659 + default: &660 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -97040,8 +97091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -97096,9 +97147,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *659 examples: - default: *659 + default: *660 '422': *15 '409': *112 x-github: @@ -97121,8 +97172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -97230,8 +97281,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -97257,8 +97308,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -97268,7 +97319,7 @@ paths: application/json: schema: type: array - items: &660 + items: &661 title: Page Build description: Page Build type: object @@ -97360,8 +97411,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *438 - *439 + - *440 responses: '201': description: Response @@ -97408,16 +97459,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *660 + schema: *661 examples: - default: &661 + default: &662 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -97465,8 +97516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *438 - *439 + - *440 - name: build_id in: path required: true @@ -97477,9 +97528,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *661 examples: - default: *661 + default: *662 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97499,8 +97550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -97608,9 +97659,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *438 - *439 - - &662 + - *440 + - &663 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -97668,9 +97719,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *438 - *439 - - *662 + - *440 + - *663 responses: '204': *144 '404': *6 @@ -97697,8 +97748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -97993,8 +98044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Private vulnerability reporting status @@ -98031,8 +98082,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': *144 '422': *14 @@ -98053,8 +98104,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': *144 '422': *14 @@ -98076,8 +98127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -98087,7 +98138,7 @@ paths: type: array items: *145 examples: - default: *663 + default: *664 '403': *27 '404': *6 x-github: @@ -98109,8 +98160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -98126,7 +98177,7 @@ paths: required: - properties examples: - default: *664 + default: *665 responses: '204': description: No Content when custom property values are successfully created @@ -98164,8 +98215,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *438 - *439 + - *440 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -98225,9 +98276,9 @@ paths: application/json: schema: type: array - items: *556 + items: *557 examples: - default: *665 + default: *666 headers: Link: *41 '304': *35 @@ -98259,8 +98310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -98327,7 +98378,7 @@ paths: description: Response content: application/json: - schema: &669 + schema: &670 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -98567,7 +98618,7 @@ paths: - review_comment - self author_association: *206 - auto_merge: *666 + auto_merge: *667 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -98669,7 +98720,7 @@ paths: - merged_by - review_comments examples: - default: &670 + default: &671 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -99196,8 +99247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *438 - *439 + - *440 - name: sort in: query required: false @@ -99226,9 +99277,9 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: - default: &672 + default: &673 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99305,17 +99356,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *438 - *439 + - *440 - *218 responses: '200': description: Response content: application/json: - schema: *667 + schema: *668 examples: - default: &668 + default: &669 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99390,8 +99441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -99414,9 +99465,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: - default: *668 + default: *669 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99432,8 +99483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *438 - *439 + - *440 - *218 responses: '204': @@ -99455,8 +99506,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *438 - *439 + - *440 - *218 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -99483,9 +99534,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -99506,8 +99557,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *438 - *439 + - *440 - *218 requestBody: required: true @@ -99540,16 +99591,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -99571,10 +99622,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *438 - *439 + - *440 - *218 - - *430 + - *431 responses: '204': description: Response @@ -99617,9 +99668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *438 - *439 - - &671 + - *440 + - &672 name: pull_number description: The number that identifies the pull request. in: path @@ -99632,9 +99683,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '304': *35 '404': *6 '406': @@ -99669,9 +99720,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -99713,9 +99764,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *670 examples: - default: *670 + default: *671 '422': *15 '403': *27 x-github: @@ -99737,9 +99788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: true content: @@ -99802,7 +99853,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -99810,7 +99861,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '401': *23 '403': *27 '404': *6 @@ -99840,9 +99891,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *228 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -99863,9 +99914,9 @@ paths: application/json: schema: type: array - items: *667 + items: *668 examples: - default: *672 + default: *673 headers: Link: *41 x-github: @@ -99898,9 +99949,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: true content: @@ -100006,7 +100057,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: example-for-a-multi-line-comment: value: @@ -100094,9 +100145,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *218 requestBody: required: true @@ -100119,7 +100170,7 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: default: value: @@ -100205,9 +100256,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *17 - *19 responses: @@ -100217,9 +100268,9 @@ paths: application/json: schema: type: array - items: *552 + items: *553 examples: - default: *673 + default: *674 headers: Link: *41 x-github: @@ -100249,9 +100300,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *17 - *19 responses: @@ -100261,7 +100312,7 @@ paths: application/json: schema: type: array - items: *563 + items: *564 examples: default: value: @@ -100299,9 +100350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *438 - *439 - - *671 + - *440 + - *672 responses: '204': description: Response if pull request has been merged @@ -100324,9 +100375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -100438,9 +100489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 responses: '200': description: Response @@ -100515,9 +100566,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -100554,7 +100605,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *557 examples: default: value: @@ -101090,9 +101141,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: true content: @@ -101126,7 +101177,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *557 examples: default: value: @@ -101631,9 +101682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 - *17 - *19 responses: @@ -101643,7 +101694,7 @@ paths: application/json: schema: type: array - items: &674 + items: &675 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -101799,9 +101850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -101891,9 +101942,9 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: &676 + default: &677 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -101956,10 +102007,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - &675 + - *440 + - *672 + - &676 name: review_id description: The unique identifier of the review. in: path @@ -101971,9 +102022,9 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: &677 + default: &678 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -102032,10 +102083,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 requestBody: required: true content: @@ -102058,7 +102109,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -102120,18 +102171,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 responses: '200': description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: *676 + default: *677 '422': *7 '404': *6 x-github: @@ -102158,10 +102209,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 - *17 - *19 responses: @@ -102419,10 +102470,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 requestBody: required: true content: @@ -102451,7 +102502,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: default: value: @@ -102514,10 +102565,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *438 - *439 - - *671 - - *675 + - *440 + - *672 + - *676 requestBody: required: true content: @@ -102552,9 +102603,9 @@ paths: description: Response content: application/json: - schema: *674 + schema: *675 examples: - default: *677 + default: *678 '404': *6 '422': *7 '403': *27 @@ -102576,9 +102627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *438 - *439 - - *671 + - *440 + - *672 requestBody: required: false content: @@ -102642,8 +102693,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *438 - *439 + - *440 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -102656,9 +102707,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: &679 + default: &680 value: type: file encoding: base64 @@ -102700,8 +102751,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *438 - *439 + - *440 - name: dir description: The alternate path to look for a README file in: path @@ -102721,9 +102772,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *679 examples: - default: *679 + default: *680 '404': *6 '422': *15 x-github: @@ -102745,8 +102796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -102756,7 +102807,7 @@ paths: application/json: schema: type: array - items: &680 + items: &681 title: Release description: A release. type: object @@ -102838,7 +102889,7 @@ paths: author: *4 assets: type: array - items: &681 + items: &682 title: Release Asset description: Data related to a release. type: object @@ -103025,8 +103076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -103102,9 +103153,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: &684 + default: &685 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -103209,9 +103260,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *438 - *439 - - &682 + - *440 + - &683 name: asset_id description: The unique identifier of the asset. in: path @@ -103223,9 +103274,9 @@ paths: description: Response content: application/json: - schema: *681 + schema: *682 examples: - default: &683 + default: &684 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -103260,7 +103311,7 @@ paths: type: User site_admin: false '404': *6 - '302': *565 + '302': *566 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103276,9 +103327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *438 - *439 - - *682 + - *440 + - *683 requestBody: required: false content: @@ -103307,9 +103358,9 @@ paths: description: Response content: application/json: - schema: *681 + schema: *682 examples: - default: *683 + default: *684 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103325,9 +103376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *438 - *439 - - *682 + - *440 + - *683 responses: '204': description: Response @@ -103351,8 +103402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -103438,16 +103489,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *438 - *439 + - *440 responses: '200': description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103464,8 +103515,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *438 - *439 + - *440 - name: tag description: tag parameter in: path @@ -103478,9 +103529,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 '404': *6 x-github: githubCloudOnly: false @@ -103502,9 +103553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *438 - *439 - - &685 + - *440 + - &686 name: release_id description: The unique identifier of the release. in: path @@ -103518,9 +103569,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 '401': description: Unauthorized x-github: @@ -103538,9 +103589,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 requestBody: required: false content: @@ -103604,9 +103655,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *681 examples: - default: *684 + default: *685 '404': description: Not Found if the discussion category name is invalid content: @@ -103627,9 +103678,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 responses: '204': description: Response @@ -103649,9 +103700,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *438 - *439 - - *685 + - *440 + - *686 - *17 - *19 responses: @@ -103661,7 +103712,7 @@ paths: application/json: schema: type: array - items: *681 + items: *682 examples: default: value: @@ -103743,9 +103794,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *438 - *439 - - *685 + - *440 + - *686 - name: name in: query required: true @@ -103771,7 +103822,7 @@ paths: description: Response for successful upload content: application/json: - schema: *681 + schema: *682 examples: response-for-successful-upload: value: @@ -103826,9 +103877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -103852,9 +103903,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 '404': *6 @@ -103875,9 +103926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *438 - *439 - - *685 + - *440 + - *686 requestBody: required: true content: @@ -103907,16 +103958,16 @@ paths: description: Reaction exists content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '201': description: Reaction created content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -103938,10 +103989,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *438 - *439 - - *685 - - *430 + - *440 + - *686 + - *431 responses: '204': description: Response @@ -103965,9 +104016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *438 - *439 - - *495 + - *440 + - *496 - *17 - *19 responses: @@ -103984,7 +104035,7 @@ paths: oneOf: - allOf: - *159 - - &686 + - &687 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -104005,67 +104056,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *160 - - *686 + - *687 - allOf: - *161 - - *686 + - *687 - allOf: - *162 - - *686 + - *687 - allOf: + - *688 - *687 - - *686 - allOf: - *163 - - *686 + - *687 - allOf: - *164 - - *686 + - *687 - allOf: - *165 - - *686 + - *687 - allOf: - *166 - - *686 + - *687 - allOf: - *167 - - *686 + - *687 - allOf: - *168 - - *686 + - *687 - allOf: - *169 - - *686 + - *687 - allOf: - *170 - - *686 + - *687 - allOf: - *171 - - *686 + - *687 - allOf: - *172 - - *686 + - *687 - allOf: - *173 - - *686 + - *687 - allOf: - *174 - - *686 + - *687 - allOf: - *175 - - *686 + - *687 - allOf: - *176 - - *686 + - *687 - allOf: - *177 - - *686 + - *687 - allOf: - *178 - - *686 + - *687 - allOf: - - *688 - - *686 + - *689 + - *687 examples: default: value: @@ -104104,8 +104155,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - *17 - *19 - name: includes_parents @@ -104116,7 +104167,7 @@ paths: schema: type: boolean default: true - - *689 + - *690 responses: '200': description: Response @@ -104171,8 +104222,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 requestBody: description: Request body required: true @@ -104201,7 +104252,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *690 + items: *691 required: - name - enforcement @@ -104234,7 +104285,7 @@ paths: application/json: schema: *179 examples: - default: &699 + default: &700 value: id: 42 name: super cool ruleset @@ -104281,12 +104332,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *438 - *439 - - *691 - - *99 + - *440 - *692 + - *99 - *693 + - *694 - *17 - *19 responses: @@ -104294,9 +104345,9 @@ paths: description: Response content: application/json: - schema: *694 + schema: *695 examples: - default: *695 + default: *696 '404': *6 '500': *38 x-github: @@ -104317,17 +104368,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *438 - *439 - - *696 + - *440 + - *697 responses: '200': description: Response content: application/json: - schema: *697 + schema: *698 examples: - default: *698 + default: *699 '404': *6 '500': *38 x-github: @@ -104355,8 +104406,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104378,7 +104429,7 @@ paths: application/json: schema: *179 examples: - default: *699 + default: *700 '404': *6 '500': *38 put: @@ -104396,8 +104447,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104431,7 +104482,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *690 + items: *691 examples: default: value: @@ -104461,7 +104512,7 @@ paths: application/json: schema: *179 examples: - default: *699 + default: *700 '404': *6 '500': *38 delete: @@ -104479,8 +104530,8 @@ paths: category: repos subcategory: rules parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104503,8 +104554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *438 - *439 + - *440 - *17 - *19 - name: ruleset_id @@ -104541,8 +104592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *438 - *439 + - *440 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104615,21 +104666,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *438 - *439 + - *440 - *399 - *400 - *401 - *402 + - *403 - *104 - *19 - *17 - - *700 - *701 - - *403 + - *702 - *404 - *405 - *406 + - *407 responses: '200': description: Response @@ -104637,7 +104689,7 @@ paths: application/json: schema: type: array - items: &705 + items: &706 type: object properties: number: *119 @@ -104653,8 +104705,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *702 - resolution: *703 + state: *703 + resolution: *704 resolved_at: type: - string @@ -104748,7 +104800,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *704 + - *705 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -104893,16 +104945,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *438 - *439 - - *523 - - *406 + - *440 + - *524 + - *407 responses: '200': description: Response content: application/json: - schema: *705 + schema: *706 examples: default: value: @@ -104944,6 +104996,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -104954,9 +105008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 requestBody: required: true content: @@ -104964,28 +105018,44 @@ paths: schema: type: object properties: - state: *702 - resolution: *703 + state: *703 + resolution: *704 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: + - string + - 'null' anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *705 + schema: *706 examples: default: value: @@ -105030,6 +105100,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -105037,7 +105126,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': *184 x-github: enabledForGitHubApps: true @@ -105060,9 +105150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *438 - *439 - - *523 + - *440 + - *524 - *19 - *17 responses: @@ -105073,7 +105163,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &880 + items: &881 type: object properties: type: @@ -105100,7 +105190,6 @@ paths: - commit details: oneOf: - - *706 - *707 - *708 - *709 @@ -105113,6 +105202,7 @@ paths: - *716 - *717 - *718 + - *719 examples: default: value: @@ -105198,8 +105288,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -105207,14 +105297,14 @@ paths: schema: type: object properties: - reason: &720 + reason: &721 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *719 + placeholder_id: *720 required: - reason - placeholder_id @@ -105231,7 +105321,7 @@ paths: schema: type: object properties: - reason: *720 + reason: *721 expire_at: type: - string @@ -105278,8 +105368,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *438 - *439 + - *440 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -105294,7 +105384,7 @@ paths: properties: incremental_scans: type: array - items: &721 + items: &722 description: Information on a single scan performed by secret scanning on the repository type: object @@ -105322,15 +105412,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *721 + items: *722 backfill_scans: type: array - items: *721 + items: *722 custom_pattern_backfill_scans: type: array items: allOf: - - *721 + - *722 - type: object properties: pattern_name: @@ -105400,8 +105490,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *438 - *439 + - *440 - *104 - name: sort description: The property to sort the results by. @@ -105445,9 +105535,9 @@ paths: application/json: schema: type: array - items: *722 + items: *723 examples: - default: *723 + default: *724 '400': *14 '404': *6 x-github: @@ -105470,8 +105560,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -105551,7 +105641,7 @@ paths: login: type: string description: The username of the user credited. - type: *411 + type: *412 required: - login - type @@ -105641,9 +105731,9 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: - default: &725 + default: &726 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -105876,8 +105966,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -105990,7 +106080,7 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: default: value: @@ -106137,17 +106227,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *438 - *439 - - *724 + - *440 + - *725 responses: '200': description: Response content: application/json: - schema: *722 + schema: *723 examples: - default: *725 + default: *726 '403': *27 '404': *6 x-github: @@ -106171,9 +106261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *438 - *439 - - *724 + - *440 + - *725 requestBody: required: true content: @@ -106253,7 +106343,7 @@ paths: login: type: string description: The username of the user credited. - type: *411 + type: *412 required: - login - type @@ -106344,10 +106434,10 @@ paths: description: Response content: application/json: - schema: *722 + schema: *723 examples: - default: *725 - add_credit: *725 + default: *726 + add_credit: *726 '403': *27 '404': *6 '422': @@ -106385,9 +106475,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *438 - *439 - - *724 + - *440 + - *725 responses: '202': *37 '400': *14 @@ -106414,17 +106504,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *438 - *439 - - *724 + - *440 + - *725 responses: '202': description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 '400': *14 '422': *15 '403': *27 @@ -106450,8 +106540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -106547,8 +106637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *438 - *439 + - *440 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -106557,7 +106647,7 @@ paths: application/json: schema: type: array - items: &726 + items: &727 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106590,8 +106680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -106669,8 +106759,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -106764,8 +106854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *438 - *439 + - *440 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -106919,8 +107009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *438 - *439 + - *440 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -106930,7 +107020,7 @@ paths: application/json: schema: type: array - items: *726 + items: *727 examples: default: value: @@ -106963,8 +107053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *438 - *439 + - *440 - name: sha in: path required: true @@ -107020,7 +107110,7 @@ paths: description: Response content: application/json: - schema: *727 + schema: *728 examples: default: value: @@ -107074,8 +107164,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -107107,14 +107197,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *438 - *439 + - *440 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &728 + schema: &729 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -107187,8 +107277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *438 - *439 + - *440 requestBody: required: false content: @@ -107214,7 +107304,7 @@ paths: description: Response content: application/json: - schema: *728 + schema: *729 examples: default: value: @@ -107241,8 +107331,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -107262,8 +107352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -107345,8 +107435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -107354,7 +107444,7 @@ paths: application/json: schema: type: array - items: &729 + items: &730 title: Tag protection description: Tag protection type: object @@ -107411,8 +107501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -107435,7 +107525,7 @@ paths: description: Response content: application/json: - schema: *729 + schema: *730 examples: default: value: @@ -107466,8 +107556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *438 - *439 + - *440 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -107504,8 +107594,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *438 - *439 + - *440 - name: ref in: path required: true @@ -107541,8 +107631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *438 - *439 + - *440 - *17 - *19 responses: @@ -107574,8 +107664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *438 - *439 + - *440 - *19 - *17 responses: @@ -107583,7 +107673,7 @@ paths: description: Response content: application/json: - schema: &730 + schema: &731 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -107595,7 +107685,7 @@ paths: required: - names examples: - default: &731 + default: &732 value: names: - octocat @@ -107618,8 +107708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -107650,9 +107740,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *731 examples: - default: *731 + default: *732 '404': *6 '422': *7 x-github: @@ -107673,9 +107763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *438 - *439 - - &732 + - *440 + - &733 name: per description: The time frame to display results for. in: query @@ -107706,7 +107796,7 @@ paths: - 128 clones: type: array - items: &733 + items: &734 title: Traffic type: object properties: @@ -107793,8 +107883,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -107888,8 +107978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *438 - *439 + - *440 responses: '200': description: Response @@ -107952,9 +108042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *438 - *439 - - *732 + - *440 + - *733 responses: '200': description: Response @@ -107975,7 +108065,7 @@ paths: - 3782 views: type: array - items: *733 + items: *734 required: - uniques - count @@ -108052,8 +108142,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *438 - *439 + - *440 requestBody: required: true content: @@ -108327,8 +108417,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *438 - *439 + - *440 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -108351,8 +108441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -108374,8 +108464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -108401,8 +108491,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *438 - *439 + - *440 - name: ref in: path required: true @@ -108494,9 +108584,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -108647,7 +108737,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &741 + - &742 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -108657,7 +108747,7 @@ paths: type: string examples: - members - - &746 + - &747 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -108669,7 +108759,7 @@ paths: format: int32 examples: - 1 - - &747 + - &748 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -108713,7 +108803,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &736 + items: &737 allOf: - type: object required: @@ -108795,7 +108885,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &748 + meta: &749 type: object description: The metadata associated with the creation/updates to the user. @@ -108860,30 +108950,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &737 + '400': &738 description: Bad request content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '401': *735 - '403': &738 + schema: *735 + '401': *736 + '403': &739 description: Permission denied - '429': &739 + '429': &740 description: Too many requests content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '500': &740 + schema: *735 + '500': &741 description: Internal server error content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 + schema: *735 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108907,7 +108997,7 @@ paths: required: true content: application/json: - schema: &744 + schema: &745 type: object required: - schemas @@ -108971,9 +109061,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *736 + schema: *737 examples: - group: &742 + group: &743 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -108992,13 +109082,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *737 - '401': *735 - '403': *738 - '409': &745 + '400': *738 + '401': *736 + '403': *739 + '409': &746 description: Duplicate record detected - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109015,7 +109105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &743 + - &744 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -109024,22 +109114,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *741 + - *742 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *736 + schema: *737 examples: - default: *742 - '400': *737 - '401': *735 - '403': *738 + default: *743 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109058,13 +109148,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *743 + - *744 - *39 requestBody: required: true content: application/json: - schema: *744 + schema: *745 examples: group: summary: Group @@ -109090,17 +109180,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *736 + schema: *737 examples: - group: *742 - groupWithMembers: *742 - '400': *737 - '401': *735 - '403': *738 + group: *743 + groupWithMembers: *743 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109124,13 +109214,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *743 + - *744 - *39 requestBody: required: true content: application/json: - schema: &755 + schema: &756 type: object required: - Operations @@ -109190,17 +109280,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *736 + schema: *737 examples: - updateGroup: *742 - addMembers: *742 - '400': *737 - '401': *735 - '403': *738 + updateGroup: *743 + addMembers: *743 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109216,17 +109306,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *743 + - *744 - *39 responses: '204': description: Group was deleted, no content - '400': *737 - '401': *735 - '403': *738 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109260,8 +109350,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *746 - *747 + - *748 - *39 responses: '200': @@ -109295,7 +109385,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &750 + items: &751 allOf: - type: object required: @@ -109387,7 +109477,7 @@ paths: address. examples: - true - roles: &749 + roles: &750 type: array description: The roles assigned to the user. items: @@ -109446,7 +109536,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *748 + meta: *749 startIndex: type: integer description: A starting index for the returned page @@ -109485,11 +109575,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *737 - '401': *735 - '403': *738 - '429': *739 - '500': *740 + '400': *738 + '401': *736 + '403': *739 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109513,7 +109603,7 @@ paths: required: true content: application/json: - schema: &753 + schema: &754 type: object required: - schemas @@ -109606,9 +109696,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *749 + roles: *750 examples: - user: &754 + user: &755 summary: User value: schemas: @@ -109655,9 +109745,9 @@ paths: description: User has been created content: application/scim+json: - schema: *750 + schema: *751 examples: - user: &751 + user: &752 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -109683,13 +109773,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *751 - '400': *737 - '401': *735 - '403': *738 - '409': *745 - '429': *739 - '500': *740 + enterpriseOwner: *752 + '400': *738 + '401': *736 + '403': *739 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109706,7 +109796,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &752 + - &753 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -109719,15 +109809,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *750 + schema: *751 examples: - default: *751 - '400': *737 - '401': *735 - '403': *738 + default: *752 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109749,30 +109839,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *752 + - *753 - *39 requestBody: required: true content: application/json: - schema: *753 + schema: *754 examples: - user: *754 + user: *755 responses: '200': description: User was updated content: application/scim+json: - schema: *750 + schema: *751 examples: - user: *751 - '400': *737 - '401': *735 - '403': *738 + user: *752 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109807,13 +109897,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *752 + - *753 - *39 requestBody: required: true content: application/json: - schema: *755 + schema: *756 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -109853,18 +109943,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *750 + schema: *751 examples: - userMultiValuedProperties: *751 - userSingleValuedProperties: *751 - disableUser: *751 - '400': *737 - '401': *735 - '403': *738 + userMultiValuedProperties: *752 + userSingleValuedProperties: *752 + disableUser: *752 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '409': *745 - '429': *739 - '500': *740 + '409': *746 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109884,17 +109974,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *752 + - *753 - *39 responses: '204': description: User was deleted, no content - '400': *737 - '401': *735 - '403': *738 + '400': *738 + '401': *736 + '403': *739 '404': *6 - '429': *739 - '500': *740 + '429': *740 + '500': *741 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109985,7 +110075,7 @@ paths: - 1 Resources: type: array - items: &756 + items: &757 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -110232,22 +110322,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &757 + '404': &758 description: Resource not found content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '403': &758 + schema: *735 + '403': &759 description: Forbidden content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '400': *737 - '429': *739 + schema: *735 + '400': *738 + '429': *740 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -110273,9 +110363,9 @@ paths: description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: &759 + default: &760 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -110298,17 +110388,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *757 - '403': *758 - '500': *740 + '404': *758 + '403': *759 + '500': *741 '409': description: Conflict content: application/json: - schema: *734 + schema: *735 application/scim+json: - schema: *734 - '400': *737 + schema: *735 + '400': *738 requestBody: required: true content: @@ -110408,17 +110498,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *81 - - *752 + - *753 responses: '200': description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: *759 - '404': *757 - '403': *758 + default: *760 + '404': *758 + '403': *759 '304': *35 x-github: githubCloudOnly: true @@ -110442,18 +110532,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *81 - - *752 + - *753 responses: '200': description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: *759 + default: *760 '304': *35 - '404': *757 - '403': *758 + '404': *758 + '403': *759 requestBody: required: true content: @@ -110568,19 +110658,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *81 - - *752 + - *753 responses: '200': description: Response content: application/scim+json: - schema: *756 + schema: *757 examples: - default: *759 + default: *760 '304': *35 - '404': *757 - '403': *758 - '400': *737 + '404': *758 + '403': *759 + '400': *738 '429': description: Response content: @@ -110676,12 +110766,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *81 - - *752 + - *753 responses: '204': description: Response - '404': *757 - '403': *758 + '404': *758 + '403': *759 '304': *35 x-github: githubCloudOnly: true @@ -110815,7 +110905,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &760 + text_matches: &761 title: Search Result Text Matches type: array items: @@ -110979,7 +111069,7 @@ paths: enum: - author-date - committer-date - - &761 + - &762 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -111048,7 +111138,7 @@ paths: committer: anyOf: - type: 'null' - - *493 + - *494 comment_count: type: integer message: @@ -111067,7 +111157,7 @@ paths: url: type: string format: uri - verification: *610 + verification: *611 required: - author - committer @@ -111082,7 +111172,7 @@ paths: committer: anyOf: - type: 'null' - - *493 + - *494 parents: type: array items: @@ -111099,7 +111189,7 @@ paths: type: number node_id: type: string - text_matches: *760 + text_matches: *761 required: - sha - node_id @@ -111292,7 +111382,7 @@ paths: - interactions - created - updated - - *761 + - *762 - *17 - *19 - name: advanced_search @@ -111389,11 +111479,11 @@ paths: type: - string - 'null' - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: type: string state_reason: @@ -111421,7 +111511,7 @@ paths: - string - 'null' format: date-time - text_matches: *760 + text_matches: *761 pull_request: type: object properties: @@ -111644,7 +111734,7 @@ paths: enum: - created - updated - - *761 + - *762 - *17 - *19 responses: @@ -111689,7 +111779,7 @@ paths: - 'null' score: type: number - text_matches: *760 + text_matches: *761 required: - id - node_id @@ -111775,7 +111865,7 @@ paths: - forks - help-wanted-issues - updated - - *761 + - *762 - *17 - *19 responses: @@ -112012,7 +112102,7 @@ paths: - admin - pull - push - text_matches: *760 + text_matches: *761 temp_clone_token: type: string allow_merge_commit: @@ -112321,7 +112411,7 @@ paths: - string - 'null' format: uri - text_matches: *760 + text_matches: *761 related: type: - array @@ -112516,7 +112606,7 @@ paths: - followers - repositories - joined - - *761 + - *762 - *17 - *19 responses: @@ -112626,7 +112716,7 @@ paths: type: - boolean - 'null' - text_matches: *760 + text_matches: *761 blog: type: - string @@ -112708,7 +112798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &765 + - &766 name: team_id description: The unique identifier of the team. in: path @@ -112720,9 +112810,9 @@ paths: description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 x-github: githubCloudOnly: false @@ -112749,7 +112839,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *765 + - *766 requestBody: required: true content: @@ -112813,16 +112903,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '201': description: Response content: application/json: - schema: *419 + schema: *420 examples: - default: *420 + default: *421 '404': *6 '422': *15 '403': *27 @@ -112850,7 +112940,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *765 + - *766 responses: '204': description: Response @@ -112881,7 +112971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *765 + - *766 - *104 - *17 - *19 @@ -112892,9 +112982,9 @@ paths: application/json: schema: type: array - items: *421 + items: *422 examples: - default: *766 + default: *767 headers: Link: *41 x-github: @@ -112923,7 +113013,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *765 + - *766 requestBody: required: true content: @@ -112957,9 +113047,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *422 + default: *423 x-github: triggersNotification: true githubCloudOnly: false @@ -112986,16 +113076,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 responses: '200': description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *422 + default: *423 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113020,8 +113110,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 requestBody: required: false content: @@ -113044,9 +113134,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *422 examples: - default: *767 + default: *768 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113071,8 +113161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 responses: '204': description: Response @@ -113101,8 +113191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *765 - - *423 + - *766 + - *424 - *104 - *17 - *19 @@ -113113,9 +113203,9 @@ paths: application/json: schema: type: array - items: *424 + items: *425 examples: - default: *768 + default: *769 headers: Link: *41 x-github: @@ -113144,8 +113234,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *765 - - *423 + - *766 + - *424 requestBody: required: true content: @@ -113167,9 +113257,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *425 + default: *426 x-github: triggersNotification: true githubCloudOnly: false @@ -113196,17 +113286,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 responses: '200': description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *425 + default: *426 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113231,9 +113321,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 requestBody: required: true content: @@ -113255,9 +113345,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *425 examples: - default: *769 + default: *770 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113282,9 +113372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 responses: '204': description: Response @@ -113313,9 +113403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -113341,9 +113431,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 x-github: @@ -113372,9 +113462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *765 - - *423 - - *426 + - *766 + - *424 + - *427 requestBody: required: true content: @@ -113406,9 +113496,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113434,8 +113524,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -113461,9 +113551,9 @@ paths: application/json: schema: type: array - items: *427 + items: *428 examples: - default: *429 + default: *430 headers: Link: *41 x-github: @@ -113492,8 +113582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *765 - - *423 + - *766 + - *424 requestBody: required: true content: @@ -113525,9 +113615,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *428 examples: - default: *428 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113551,7 +113641,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -113589,7 +113679,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *765 + - *766 - name: role description: Filters members returned by their role in the team. in: query @@ -113640,7 +113730,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113677,7 +113767,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113717,7 +113807,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113754,16 +113844,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *765 + - *766 - *132 responses: '200': description: Response content: application/json: - schema: *435 + schema: *436 examples: - response-if-user-is-a-team-maintainer: *770 + response-if-user-is-a-team-maintainer: *771 '404': *6 x-github: githubCloudOnly: false @@ -113796,7 +113886,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *765 + - *766 - *132 requestBody: required: false @@ -113822,9 +113912,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *436 examples: - response-if-users-membership-with-team-is-now-pending: *771 + response-if-users-membership-with-team-is-now-pending: *772 '403': description: Forbidden if team synchronization is set up '422': @@ -113858,7 +113948,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *765 + - *766 - *132 responses: '204': @@ -113887,7 +113977,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -113897,9 +113987,9 @@ paths: application/json: schema: type: array - items: *436 + items: *437 examples: - default: *772 + default: *773 headers: Link: *41 '404': *6 @@ -113925,16 +114015,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *765 - - *437 + - *766 + - *438 responses: '200': description: Response content: application/json: - schema: *436 + schema: *437 examples: - default: *773 + default: *774 '404': description: Not Found if project is not managed by this team x-github: @@ -113958,8 +114048,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *765 - - *437 + - *766 + - *438 requestBody: required: false content: @@ -114026,8 +114116,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *765 - - *437 + - *766 + - *438 responses: '204': description: Response @@ -114054,7 +114144,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -114096,15 +114186,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *765 - - *438 + - *766 - *439 + - *440 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *774 + schema: *775 examples: alternative-response-with-extra-repository-information: value: @@ -114255,9 +114345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *765 - - *438 + - *766 - *439 + - *440 requestBody: required: false content: @@ -114307,9 +114397,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *765 - - *438 + - *766 - *439 + - *440 responses: '204': description: Response @@ -114338,15 +114428,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *765 + - *766 responses: '200': description: Response content: application/json: - schema: *440 + schema: *441 examples: - default: *441 + default: *442 '403': *27 '404': *6 x-github: @@ -114373,7 +114463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *765 + - *766 requestBody: required: true content: @@ -114434,7 +114524,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *441 examples: default: value: @@ -114465,7 +114555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *765 + - *766 - *17 - *19 responses: @@ -114477,7 +114567,7 @@ paths: type: array items: *292 examples: - response-if-child-teams-exist: *775 + response-if-child-teams-exist: *776 headers: Link: *41 '404': *6 @@ -114510,7 +114600,7 @@ paths: application/json: schema: oneOf: - - &777 + - &778 title: Private User description: Private User type: object @@ -114760,7 +114850,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *776 + - *777 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -114920,7 +115010,7 @@ paths: description: Response content: application/json: - schema: *777 + schema: *778 examples: default: value: @@ -115266,7 +115356,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -115274,7 +115364,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '401': *23 '403': *27 '404': *6 @@ -115318,7 +115408,7 @@ paths: type: integer secrets: type: array - items: &778 + items: &779 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -115360,7 +115450,7 @@ paths: - visibility - selected_repositories_url examples: - default: *545 + default: *546 headers: Link: *41 x-github: @@ -115438,7 +115528,7 @@ paths: description: Response content: application/json: - schema: *778 + schema: *779 examples: default: value: @@ -115584,7 +115674,7 @@ paths: type: array items: *263 examples: - default: *779 + default: *780 '401': *23 '403': *27 '404': *6 @@ -115736,7 +115826,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '304': *35 '500': *38 '401': *23 @@ -115794,7 +115884,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '401': *23 '403': *27 '404': *6 @@ -115851,7 +115941,7 @@ paths: description: Response content: application/json: - schema: &780 + schema: &781 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -115904,7 +115994,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &781 + default: &782 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -115949,9 +116039,9 @@ paths: description: Response content: application/json: - schema: *780 + schema: *781 examples: - default: *781 + default: *782 '404': *6 x-github: githubCloudOnly: false @@ -115988,9 +116078,9 @@ paths: type: integer machines: type: array - items: *544 + items: *545 examples: - default: *782 + default: *783 '304': *35 '500': *38 '401': *23 @@ -116075,11 +116165,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *449 + repository: *450 machine: anyOf: - type: 'null' - - *544 + - *545 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -116884,7 +116974,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '304': *35 '500': *38 '400': *14 @@ -116924,7 +117014,7 @@ paths: application/json: schema: *352 examples: - default: *543 + default: *544 '500': *38 '401': *23 '403': *27 @@ -116956,7 +117046,7 @@ paths: type: array items: *362 examples: - default: &793 + default: &794 value: - id: 197 name: hello_docker @@ -117057,7 +117147,7 @@ paths: application/json: schema: type: array - items: &783 + items: &784 title: Email description: Email type: object @@ -117127,9 +117217,9 @@ paths: application/json: schema: type: array - items: *783 + items: *784 examples: - default: &795 + default: &796 value: - email: octocat@github.com verified: true @@ -117206,7 +117296,7 @@ paths: application/json: schema: type: array - items: *783 + items: *784 examples: default: value: @@ -117464,7 +117554,7 @@ paths: application/json: schema: type: array - items: &784 + items: &785 title: GPG Key description: A unique encryption key type: object @@ -117609,7 +117699,7 @@ paths: - subkeys - revoked examples: - default: &809 + default: &810 value: - id: 3 name: Octocat's GPG Key @@ -117694,9 +117784,9 @@ paths: description: Response content: application/json: - schema: *784 + schema: *785 examples: - default: &785 + default: &786 value: id: 3 name: Octocat's GPG Key @@ -117753,7 +117843,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &786 + - &787 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -117765,9 +117855,9 @@ paths: description: Response content: application/json: - schema: *784 + schema: *785 examples: - default: *785 + default: *786 '404': *6 '304': *35 '403': *27 @@ -117790,7 +117880,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *786 + - *787 responses: '204': description: Response @@ -118095,7 +118185,7 @@ paths: required: true content: application/json: - schema: *621 + schema: *622 examples: default: value: @@ -118245,7 +118335,7 @@ paths: application/json: schema: type: array - items: &787 + items: &788 title: Key description: Key type: object @@ -118348,9 +118438,9 @@ paths: description: Response content: application/json: - schema: *787 + schema: *788 examples: - default: &788 + default: &789 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118383,15 +118473,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *649 + - *650 responses: '200': description: Response content: application/json: - schema: *787 + schema: *788 examples: - default: *788 + default: *789 '404': *6 '304': *35 '403': *27 @@ -118414,7 +118504,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *649 + - *650 responses: '204': description: Response @@ -118447,7 +118537,7 @@ paths: application/json: schema: type: array - items: &789 + items: &790 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -118526,7 +118616,7 @@ paths: - account - plan examples: - default: &790 + default: &791 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -118588,9 +118678,9 @@ paths: application/json: schema: type: array - items: *789 + items: *790 examples: - default: *790 + default: *791 headers: Link: *41 '304': *35 @@ -119594,7 +119684,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *358 - - *791 + - *792 responses: '204': description: Response @@ -119709,7 +119799,7 @@ paths: - docker - nuget - container - - *792 + - *793 - *19 - *17 responses: @@ -119721,8 +119811,8 @@ paths: type: array items: *362 examples: - default: *793 - '400': *794 + default: *794 + '400': *795 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119751,7 +119841,7 @@ paths: application/json: schema: *362 examples: - default: &810 + default: &811 value: id: 40201 name: octo-name @@ -120113,9 +120203,9 @@ paths: application/json: schema: type: array - items: *783 + items: *784 examples: - default: *795 + default: *796 headers: Link: *41 '304': *35 @@ -120228,7 +120318,7 @@ paths: type: array items: *72 examples: - default: &802 + default: &803 summary: Default response value: - id: 1296269 @@ -120546,9 +120636,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *451 + default: *452 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -120586,9 +120676,9 @@ paths: application/json: schema: type: array - items: *623 + items: *624 examples: - default: *796 + default: *797 headers: Link: *41 '304': *35 @@ -120667,7 +120757,7 @@ paths: application/json: schema: type: array - items: &797 + items: &798 title: Social account description: Social media account type: object @@ -120684,7 +120774,7 @@ paths: - provider - url examples: - default: &798 + default: &799 value: - provider: twitter url: https://twitter.com/github @@ -120747,9 +120837,9 @@ paths: application/json: schema: type: array - items: *797 + items: *798 examples: - default: *798 + default: *799 '422': *15 '304': *35 '404': *6 @@ -120837,7 +120927,7 @@ paths: application/json: schema: type: array - items: &799 + items: &800 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -120857,7 +120947,7 @@ paths: - title - created_at examples: - default: &814 + default: &815 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -120922,9 +121012,9 @@ paths: description: Response content: application/json: - schema: *799 + schema: *800 examples: - default: &800 + default: &801 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -120954,7 +121044,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &801 + - &802 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -120966,9 +121056,9 @@ paths: description: Response content: application/json: - schema: *799 + schema: *800 examples: - default: *800 + default: *801 '404': *6 '304': *35 '403': *27 @@ -120991,7 +121081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *801 + - *802 responses: '204': description: Response @@ -121020,7 +121110,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &815 + - &816 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -121045,11 +121135,11 @@ paths: type: array items: *72 examples: - default-response: *802 + default-response: *803 application/vnd.github.v3.star+json: schema: type: array - items: &816 + items: &817 title: Starred Repository description: Starred Repository type: object @@ -121205,8 +121295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *438 - *439 + - *440 responses: '204': description: Response if this repository is starred by you @@ -121234,8 +121324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -121259,8 +121349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *438 - *439 + - *440 responses: '204': description: Response @@ -121332,7 +121422,7 @@ paths: application/json: schema: type: array - items: *419 + items: *420 examples: default: value: @@ -121418,10 +121508,10 @@ paths: application/json: schema: oneOf: + - *778 - *777 - - *776 examples: - default-response: &804 + default-response: &805 summary: Default response value: login: octocat @@ -121456,7 +121546,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &805 + response-with-git-hub-plan-information: &806 summary: Response with GitHub plan information value: login: octocat @@ -121578,7 +121668,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *803 + - *804 - *17 responses: '200': @@ -121627,11 +121717,11 @@ paths: application/json: schema: oneOf: + - *778 - *777 - - *776 examples: - default-response: *804 - response-with-git-hub-plan-information: *805 + default-response: *805 + response-with-git-hub-plan-information: *806 '404': *6 x-github: githubCloudOnly: false @@ -121681,8 +121771,8 @@ paths: required: - subject_digests examples: - default: *806 - withPredicateType: *807 + default: *807 + withPredicateType: *808 responses: '200': description: Response @@ -121736,7 +121826,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *808 + default: *809 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121941,7 +122031,7 @@ paths: initiator: type: string examples: - default: *489 + default: *490 '201': description: Response content: @@ -121982,7 +122072,7 @@ paths: type: array items: *362 examples: - default: *793 + default: *794 '403': *27 '401': *23 x-github: @@ -122366,9 +122456,9 @@ paths: application/json: schema: type: array - items: *784 + items: *785 examples: - default: *809 + default: *810 headers: Link: *41 x-github: @@ -122472,7 +122562,7 @@ paths: application/json: schema: *20 examples: - default: *620 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122597,7 +122687,7 @@ paths: - docker - nuget - container - - *792 + - *793 - *132 - *19 - *17 @@ -122610,10 +122700,10 @@ paths: type: array items: *362 examples: - default: *793 + default: *794 '403': *27 '401': *23 - '400': *794 + '400': *795 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122643,7 +122733,7 @@ paths: application/json: schema: *362 examples: - default: *810 + default: *811 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122992,7 +123082,7 @@ paths: type: array items: *383 examples: - default: *811 + default: *812 headers: Link: *41 '304': *35 @@ -123003,6 +123093,257 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - *132 + - *380 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response + content: + application/json: + schema: *383 + examples: + text_field: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + '304': *35 + '403': *27 + '401': *23 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -123015,7 +123356,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - *380 - - *812 + - *813 - *132 responses: '200': @@ -123024,7 +123365,7 @@ paths: application/json: schema: *383 examples: - default: *813 + default: *814 headers: Link: *41 '304': *35 @@ -123562,9 +123903,9 @@ paths: application/json: schema: type: array - items: *797 + items: *798 examples: - default: *798 + default: *799 headers: Link: *41 x-github: @@ -123594,9 +123935,9 @@ paths: application/json: schema: type: array - items: *799 + items: *800 examples: - default: *814 + default: *815 headers: Link: *41 x-github: @@ -123621,7 +123962,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *132 - - *815 + - *816 - *104 - *17 - *19 @@ -123633,11 +123974,11 @@ paths: schema: anyOf: - type: array - items: *816 + items: *817 - type: array items: *72 examples: - default-response: *802 + default-response: *803 headers: Link: *41 x-github: @@ -123797,7 +124138,7 @@ webhooks: type: string enum: - disabled - enterprise: &817 + enterprise: &818 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -123866,7 +124207,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &818 + installation: &819 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -123887,7 +124228,7 @@ webhooks: required: - id - node_id - organization: &819 + organization: &820 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -123960,7 +124301,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &820 + repository: &821 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -124873,10 +125214,10 @@ webhooks: type: string enum: - enabled - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -124952,11 +125293,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - rule: &821 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + rule: &822 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -125179,11 +125520,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - rule: *821 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + rule: *822 sender: *4 required: - action @@ -125371,11 +125712,11 @@ webhooks: - everyone required: - from - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - rule: *821 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + rule: *822 sender: *4 required: - action @@ -125448,7 +125789,7 @@ webhooks: required: true content: application/json: - schema: &841 + schema: &842 title: Exemption request cancellation event type: object properties: @@ -125456,11 +125797,11 @@ webhooks: type: string enum: - cancelled - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: &822 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: &823 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -125698,7 +126039,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &823 + items: &824 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -125810,7 +126151,7 @@ webhooks: required: true content: application/json: - schema: &842 + schema: &843 title: Exemption request completed event type: object properties: @@ -125818,11 +126159,11 @@ webhooks: type: string enum: - completed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 sender: *4 required: - action @@ -125894,7 +126235,7 @@ webhooks: required: true content: application/json: - schema: &839 + schema: &840 title: Exemption request created event type: object properties: @@ -125902,11 +126243,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 sender: *4 required: - action @@ -125978,7 +126319,7 @@ webhooks: required: true content: application/json: - schema: &843 + schema: &844 title: Exemption response dismissed event type: object properties: @@ -125986,12 +126327,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 - exemption_response: *823 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 + exemption_response: *824 sender: *4 required: - action @@ -126065,7 +126406,7 @@ webhooks: required: true content: application/json: - schema: &840 + schema: &841 title: Exemption response submitted event type: object properties: @@ -126073,12 +126414,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - exemption_request: *822 - exemption_response: *823 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + exemption_request: *823 + exemption_response: *824 sender: *4 required: - action @@ -126162,7 +126503,7 @@ webhooks: type: string enum: - completed - check_run: &825 + check_run: &826 title: CheckRun description: A check performed on the code of a given code change type: object @@ -126227,7 +126568,7 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *506 + items: *507 repository: *263 status: type: string @@ -126272,7 +126613,7 @@ webhooks: - examples: - neutral - deployment: *824 + deployment: *825 details_url: type: string examples: @@ -126332,7 +126673,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *506 + items: *507 started_at: type: string format: date-time @@ -126370,10 +126711,10 @@ webhooks: - output - app - pull_requests - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 sender: *4 required: - check_run @@ -126766,11 +127107,11 @@ webhooks: type: string enum: - created - check_run: *825 - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + check_run: *826 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 sender: *4 required: - check_run @@ -127166,11 +127507,11 @@ webhooks: type: string enum: - requested_action - check_run: *825 - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + check_run: *826 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 requested_action: description: The action requested by the user. type: object @@ -127575,11 +127916,11 @@ webhooks: type: string enum: - rerequested - check_run: *825 - installation: *818 - enterprise: *817 - organization: *819 - repository: *820 + check_run: *826 + installation: *819 + enterprise: *818 + organization: *820 + repository: *821 sender: *4 required: - check_run @@ -128571,10 +128912,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -128855,6 +129196,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -129274,10 +129620,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -129553,6 +129899,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -129971,10 +130322,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -130143,7 +130494,7 @@ webhooks: required: - login - id - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130295,20 +130646,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &826 + commit_oid: &827 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *817 - installation: *818 - organization: *819 - ref: &827 + enterprise: *818 + installation: *819 + organization: *820 + ref: &828 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *820 + repository: *821 sender: *4 required: - action @@ -130475,7 +130826,7 @@ webhooks: required: - login - id - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -130716,12 +131067,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -130819,7 +131170,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131004,12 +131355,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -131178,7 +131529,7 @@ webhooks: required: - login - id - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131355,12 +131706,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -131463,7 +131814,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131643,9 +131994,9 @@ webhooks: type: - string - 'null' - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -131653,7 +132004,7 @@ webhooks: type: - string - 'null' - repository: *820 + repository: *821 sender: *4 required: - action @@ -131752,7 +132103,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *518 + dismissed_comment: *519 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131899,12 +132250,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *826 - enterprise: *817 - installation: *818 - organization: *819 - ref: *827 - repository: *820 + commit_oid: *827 + enterprise: *818 + installation: *819 + organization: *820 + ref: *828 + repository: *821 sender: *4 required: - action @@ -132166,10 +132517,10 @@ webhooks: - updated_at - author_association - body - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -132250,18 +132601,18 @@ webhooks: type: - string - 'null' - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *819 - pusher_type: &828 + organization: *820 + pusher_type: &829 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &829 + ref: &830 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -132271,7 +132622,7 @@ webhooks: enum: - tag - branch - repository: *820 + repository: *821 sender: *4 required: - ref @@ -132354,9 +132705,9 @@ webhooks: enum: - created definition: *146 - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132441,9 +132792,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132521,9 +132872,9 @@ webhooks: enum: - promote_to_enterprise definition: *146 - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132601,9 +132952,9 @@ webhooks: enum: - updated definition: *146 - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -132680,10 +133031,10 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - repository: *820 - organization: *819 + enterprise: *818 + installation: *819 + repository: *821 + organization: *820 sender: *4 new_property_values: type: array @@ -132768,18 +133119,18 @@ webhooks: title: delete event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - pusher_type: *828 - ref: *829 + enterprise: *818 + installation: *819 + organization: *820 + pusher_type: *829 + ref: *830 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *820 + repository: *821 sender: *4 required: - ref @@ -132863,11 +133214,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -132951,11 +133302,11 @@ webhooks: type: string enum: - auto_reopened - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133039,11 +133390,11 @@ webhooks: type: string enum: - created - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133125,11 +133476,11 @@ webhooks: type: string enum: - dismissed - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133211,11 +133562,11 @@ webhooks: type: string enum: - fixed - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133298,11 +133649,11 @@ webhooks: type: string enum: - reintroduced - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133384,11 +133735,11 @@ webhooks: type: string enum: - reopened - alert: *570 - installation: *818 - organization: *819 - enterprise: *817 - repository: *820 + alert: *571 + installation: *819 + organization: *820 + enterprise: *818 + repository: *821 sender: *4 required: - action @@ -133465,9 +133816,9 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - key: &830 + enterprise: *818 + installation: *819 + key: &831 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -133505,8 +133856,8 @@ webhooks: - verified - created_at - read_only - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -133583,11 +133934,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - key: *830 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + key: *831 + organization: *820 + repository: *821 sender: *4 required: - action @@ -134159,12 +134510,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: &834 + workflow: &835 title: Workflow type: - object @@ -134902,13 +135253,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *576 + deployment: *577 pull_requests: type: array - items: *669 - repository: *820 - organization: *819 - installation: *818 + items: *670 + repository: *821 + organization: *820 + installation: *819 sender: *4 responses: '200': @@ -134979,7 +135330,7 @@ webhooks: type: string enum: - approved - approver: &831 + approver: &832 type: object properties: avatar_url: @@ -135022,11 +135373,11 @@ webhooks: type: string comment: type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - reviewers: &832 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + reviewers: &833 type: array items: type: object @@ -135107,7 +135458,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &833 + workflow_job_run: &834 type: object properties: conclusion: @@ -135853,18 +136204,18 @@ webhooks: type: string enum: - rejected - approver: *831 + approver: *832 comment: type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - reviewers: *832 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + reviewers: *833 sender: *4 since: type: string - workflow_job_run: *833 + workflow_job_run: *834 workflow_job_runs: type: array items: @@ -136581,13 +136932,13 @@ webhooks: type: string enum: - requested - enterprise: *817 + enterprise: *818 environment: type: string - installation: *818 - organization: *819 - repository: *820 - requestor: &844 + installation: *819 + organization: *820 + repository: *821 + requestor: &845 title: User type: - object @@ -138530,12 +138881,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Deployment Workflow Run type: @@ -139226,7 +139577,7 @@ webhooks: type: string enum: - answered - answer: &837 + answer: &838 type: object properties: author_association: @@ -139386,7 +139737,7 @@ webhooks: - created_at - updated_at - body - discussion: &835 + discussion: &836 title: Discussion description: A Discussion in a repository. type: object @@ -139682,7 +140033,7 @@ webhooks: - id labels: type: array - items: *632 + items: *633 required: - repository_url - category @@ -139704,10 +140055,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -139834,11 +140185,11 @@ webhooks: - from required: - category - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -139921,11 +140272,11 @@ webhooks: type: string enum: - closed - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140007,7 +140358,7 @@ webhooks: type: string enum: - created - comment: &836 + comment: &837 type: object properties: author_association: @@ -140167,11 +140518,11 @@ webhooks: - updated_at - body - reactions - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140254,12 +140605,12 @@ webhooks: type: string enum: - deleted - comment: *836 - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + comment: *837 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140354,12 +140705,12 @@ webhooks: - from required: - body - comment: *836 - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + comment: *837 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140443,11 +140794,11 @@ webhooks: type: string enum: - created - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140529,11 +140880,11 @@ webhooks: type: string enum: - deleted - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140633,11 +140984,11 @@ webhooks: type: string required: - from - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140719,10 +141070,10 @@ webhooks: type: string enum: - labeled - discussion: *835 - enterprise: *817 - installation: *818 - label: &838 + discussion: *836 + enterprise: *818 + installation: *819 + label: &839 title: Label type: object properties: @@ -140755,8 +141106,8 @@ webhooks: - color - default - description - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140839,11 +141190,11 @@ webhooks: type: string enum: - locked - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -140925,11 +141276,11 @@ webhooks: type: string enum: - pinned - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141011,11 +141362,11 @@ webhooks: type: string enum: - reopened - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141100,16 +141451,16 @@ webhooks: changes: type: object properties: - new_discussion: *835 - new_repository: *820 + new_discussion: *836 + new_repository: *821 required: - new_discussion - new_repository - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141192,10 +141543,10 @@ webhooks: type: string enum: - unanswered - discussion: *835 - old_answer: *837 - organization: *819 - repository: *820 + discussion: *836 + old_answer: *838 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141277,12 +141628,12 @@ webhooks: type: string enum: - unlabeled - discussion: *835 - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141365,11 +141716,11 @@ webhooks: type: string enum: - unlocked - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141451,11 +141802,11 @@ webhooks: type: string enum: - unpinned - discussion: *835 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + discussion: *836 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -141524,7 +141875,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141587,7 +141938,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141653,7 +142004,7 @@ webhooks: required: true content: application/json: - schema: *841 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141719,7 +142070,7 @@ webhooks: required: true content: application/json: - schema: *842 + schema: *843 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141785,7 +142136,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141851,7 +142202,7 @@ webhooks: required: true content: application/json: - schema: *843 + schema: *844 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141917,7 +142268,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -141943,71 +142294,6 @@ webhooks: externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset 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: *841 - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: true - category: webhooks - subcategory: exemption_request_push_ruleset - supported-webhook-types: - - repository - - organization - - app - exemption-request-push-ruleset-completed: - post: - summary: |- - This event occurs when there is activity related to a user's request to bypass a set of push rules. - - For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: A push ruleset bypass request was completed. - operationId: exemption-request-push-ruleset/completed - externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset - parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc @@ -142060,6 +142346,71 @@ webhooks: - repository - organization - app + exemption-request-push-ruleset-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass a set of push rules. + + For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + description: A push ruleset bypass request was completed. + operationId: exemption-request-push-ruleset/completed + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset + 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: *843 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: exemption_request_push_ruleset + supported-webhook-types: + - repository + - organization + - app exemption-request-push-ruleset-created: post: summary: |- @@ -142112,7 +142463,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142177,7 +142528,7 @@ webhooks: required: true content: application/json: - schema: *843 + schema: *844 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142243,7 +142594,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142310,7 +142661,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *817 + enterprise: *818 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -142988,9 +143339,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - forkee @@ -143136,9 +143487,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pages: description: The pages that were updated. type: array @@ -143176,7 +143527,7 @@ webhooks: - action - sha - html_url - repository: *820 + repository: *821 sender: *4 required: - pages @@ -143252,10 +143603,10 @@ webhooks: type: string enum: - created - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: &845 + organization: *820 + repositories: &846 description: An array of repository objects that the installation can access. type: array @@ -143281,8 +143632,8 @@ webhooks: - name - full_name - private - repository: *820 - requester: *844 + repository: *821 + requester: *845 sender: *4 required: - action @@ -143357,11 +143708,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -143438,11 +143789,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -143519,10 +143870,10 @@ webhooks: type: string enum: - added - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories_added: &846 + organization: *820 + repositories_added: &847 description: An array of repository objects, which were added to the installation. type: array @@ -143568,15 +143919,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *820 - repository_selection: &847 + repository: *821 + repository_selection: &848 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *844 + requester: *845 sender: *4 required: - action @@ -143655,10 +144006,10 @@ webhooks: type: string enum: - removed - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories_added: *846 + organization: *820 + repositories_added: *847 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -143685,9 +144036,9 @@ webhooks: - name - full_name - private - repository: *820 - repository_selection: *847 - requester: *844 + repository: *821 + repository_selection: *848 + requester: *845 sender: *4 required: - action @@ -143766,11 +144117,11 @@ webhooks: type: string enum: - suspend - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -143953,10 +144304,10 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 target_type: type: string @@ -144035,11 +144386,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *817 + enterprise: *818 installation: *20 - organization: *819 - repositories: *845 - repository: *820 + organization: *820 + repositories: *846 + repository: *821 requester: type: - 'null' @@ -144287,8 +144638,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -145105,8 +145456,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145467,8 +145818,8 @@ webhooks: - state - locked - assignee - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -145548,7 +145899,7 @@ webhooks: type: string enum: - deleted - comment: &848 + comment: &849 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -145715,8 +146066,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -146529,8 +146880,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146893,8 +147244,8 @@ webhooks: - state - locked - assignee - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -146974,7 +147325,7 @@ webhooks: type: string enum: - edited - changes: &872 + changes: &873 description: The changes to the comment. type: object properties: @@ -146986,9 +147337,9 @@ webhooks: type: string required: - from - comment: *848 - enterprise: *817 - installation: *818 + comment: *849 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -147804,8 +148155,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148166,8 +148517,8 @@ webhooks: - state - locked - assignee - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148257,9 +148608,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *72 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148353,9 +148704,9 @@ webhooks: type: number blocking_issue: *219 blocking_issue_repo: *72 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148448,9 +148799,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148544,9 +148895,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -148631,10 +148982,10 @@ webhooks: type: string enum: - assigned - assignee: *844 - enterprise: *817 - installation: *818 - issue: &851 + assignee: *845 + enterprise: *818 + installation: *819 + issue: &852 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -149446,11 +149797,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149570,8 +149921,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -149651,8 +150002,8 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -150469,11 +150820,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150736,8 +151087,8 @@ webhooks: required: - state - closed_at - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -150816,8 +151167,8 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151625,11 +151976,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151748,8 +152099,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -151828,8 +152179,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152660,11 +153011,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152762,7 +153113,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &849 + milestone: &850 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152905,8 +153256,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -153005,8 +153356,8 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153818,11 +154169,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153942,9 +154293,9 @@ webhooks: - active_lock_reason - body - reactions - label: *838 - organization: *819 - repository: *820 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -154024,8 +154375,8 @@ webhooks: type: string enum: - labeled - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154836,11 +155187,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154960,9 +155311,9 @@ webhooks: - active_lock_reason - body - reactions - label: *838 - organization: *819 - repository: *820 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -155042,8 +155393,8 @@ webhooks: type: string enum: - locked - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155879,11 +156230,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155980,8 +156331,8 @@ webhooks: format: uri user_view_type: type: string - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -156060,8 +156411,8 @@ webhooks: type: string enum: - milestoned - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156891,11 +157242,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156992,9 +157343,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *849 - organization: *819 - repository: *820 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -157886,11 +158237,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158467,8 +158818,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159280,11 +159631,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159403,8 +159754,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -159484,9 +159835,9 @@ webhooks: type: string enum: - pinned - enterprise: *817 - installation: *818 - issue: &850 + enterprise: *818 + installation: *819 + issue: &851 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -160292,11 +160643,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160415,8 +160766,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -160495,8 +160846,8 @@ webhooks: type: string enum: - reopened - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -161330,11 +161681,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161432,8 +161783,8 @@ webhooks: user_view_type: type: string type: *347 - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -162322,11 +162673,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162925,11 +163276,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *817 - installation: *818 - issue: *850 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *851 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163009,12 +163360,12 @@ webhooks: type: string enum: - typed - enterprise: *817 - installation: *818 - issue: *851 + enterprise: *818 + installation: *819 + issue: *852 type: *347 - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163095,7 +163446,7 @@ webhooks: type: string enum: - unassigned - assignee: &875 + assignee: &876 title: User type: - object @@ -163167,11 +163518,11 @@ webhooks: required: - login - id - enterprise: *817 - installation: *818 - issue: *851 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *852 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163250,12 +163601,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *817 - installation: *818 - issue: *851 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *852 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -163335,8 +163686,8 @@ webhooks: type: string enum: - unlocked - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -164170,11 +164521,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *762 - issue_dependencies_summary: *763 + sub_issues_summary: *763 + issue_dependencies_summary: *764 issue_field_values: type: array - items: *764 + items: *765 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164271,8 +164622,8 @@ webhooks: format: uri user_view_type: type: string - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164352,11 +164703,11 @@ webhooks: type: string enum: - unpinned - enterprise: *817 - installation: *818 - issue: *850 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + issue: *851 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164435,12 +164786,12 @@ webhooks: type: string enum: - untyped - enterprise: *817 - installation: *818 - issue: *851 + enterprise: *818 + installation: *819 + issue: *852 type: *347 - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164520,11 +164871,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164602,11 +164953,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164716,11 +165067,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - label: *838 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + label: *839 + organization: *820 + repository: *821 sender: *4 required: - action @@ -164802,9 +165153,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: &852 + enterprise: *818 + installation: *819 + marketplace_purchase: &853 title: Marketplace Purchase type: object required: @@ -164892,8 +165243,8 @@ webhooks: type: integer unit_count: type: integer - organization: *819 - previous_marketplace_purchase: &853 + organization: *820 + previous_marketplace_purchase: &854 title: Marketplace Purchase type: object properties: @@ -164977,7 +165328,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *820 + repository: *821 sender: *4 required: - action @@ -165057,10 +165408,10 @@ webhooks: - changed effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: *852 - organization: *819 + enterprise: *818 + installation: *819 + marketplace_purchase: *853 + organization: *820 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165148,7 +165499,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *820 + repository: *821 sender: *4 required: - action @@ -165230,10 +165581,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: *852 - organization: *819 + enterprise: *818 + installation: *819 + marketplace_purchase: *853 + organization: *820 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165319,7 +165670,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *820 + repository: *821 sender: *4 required: - action @@ -165400,8 +165751,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 marketplace_purchase: title: Marketplace Purchase type: object @@ -165487,9 +165838,9 @@ webhooks: type: integer unit_count: type: integer - organization: *819 - previous_marketplace_purchase: *853 - repository: *820 + organization: *820 + previous_marketplace_purchase: *854 + repository: *821 sender: *4 required: - action @@ -165569,12 +165920,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *817 - installation: *818 - marketplace_purchase: *852 - organization: *819 - previous_marketplace_purchase: *853 - repository: *820 + enterprise: *818 + installation: *819 + marketplace_purchase: *853 + organization: *820 + previous_marketplace_purchase: *854 + repository: *821 sender: *4 required: - action @@ -165676,11 +166027,11 @@ webhooks: type: string required: - to - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 sender: *4 required: - action @@ -165782,11 +166133,11 @@ webhooks: type: - string - 'null' - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 sender: *4 required: - action @@ -165865,11 +166216,11 @@ webhooks: type: string enum: - removed - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 sender: *4 required: - action @@ -165947,11 +166298,11 @@ webhooks: type: string enum: - added - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166029,7 +166380,7 @@ webhooks: required: - login - id - team: &854 + team: &855 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -166259,11 +166610,11 @@ webhooks: type: string enum: - removed - enterprise: *817 - installation: *818 - member: *844 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + member: *845 + organization: *820 + repository: *821 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166342,7 +166693,7 @@ webhooks: required: - login - id - team: *854 + team: *855 required: - action - scope @@ -166424,8 +166775,8 @@ webhooks: type: string enum: - checks_requested - installation: *818 - merge_group: &855 + installation: *819 + merge_group: &856 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -166444,15 +166795,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *510 + head_commit: *511 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -166538,10 +166889,10 @@ webhooks: - merged - invalidated - dequeued - installation: *818 - merge_group: *855 - organization: *819 - repository: *820 + installation: *819 + merge_group: *856 + organization: *820 + repository: *821 sender: *4 required: - action @@ -166614,7 +166965,7 @@ webhooks: type: string enum: - deleted - enterprise: *817 + enterprise: *818 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -166723,12 +167074,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *818 - organization: *819 + installation: *819 + organization: *820 repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -166808,11 +167159,11 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 - milestone: *849 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -166891,9 +167242,9 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - milestone: &856 + enterprise: *818 + installation: *819 + milestone: &857 title: Milestone description: A collection of related issues and pull requests. type: object @@ -167035,8 +167386,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167115,11 +167466,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - milestone: *849 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167229,11 +167580,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - milestone: *849 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *850 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167313,11 +167664,11 @@ webhooks: type: string enum: - opened - enterprise: *817 - installation: *818 - milestone: *856 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + milestone: *857 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167396,11 +167747,11 @@ webhooks: type: string enum: - blocked - blocked_user: *844 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + blocked_user: *845 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167479,11 +167830,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *844 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + blocked_user: *845 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -167559,7 +167910,7 @@ webhooks: enum: - created definition: *140 - enterprise: *817 + enterprise: *818 sender: *4 required: - action @@ -167639,8 +167990,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 sender: *4 required: - action @@ -167713,8 +168064,8 @@ webhooks: enum: - updated definition: *140 - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 sender: *4 required: - action @@ -167786,9 +168137,9 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 new_property_values: type: array @@ -167876,9 +168227,9 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - membership: &857 + enterprise: *818 + installation: *819 + membership: &858 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -167988,8 +168339,8 @@ webhooks: - role - organization_url - user - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168067,11 +168418,11 @@ webhooks: type: string enum: - member_added - enterprise: *817 - installation: *818 - membership: *857 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + membership: *858 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168150,8 +168501,8 @@ webhooks: type: string enum: - member_invited - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -168273,10 +168624,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 - user: *844 + user: *845 required: - action - invitation @@ -168354,11 +168705,11 @@ webhooks: type: string enum: - member_removed - enterprise: *817 - installation: *818 - membership: *857 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + membership: *858 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168445,11 +168796,11 @@ webhooks: properties: from: type: string - enterprise: *817 - installation: *818 - membership: *857 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + membership: *858 + organization: *820 + repository: *821 sender: *4 required: - action @@ -168525,9 +168876,9 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 package: description: Information about the package. type: object @@ -169050,7 +169401,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &858 + items: &859 title: Ruby Gems metadata type: object properties: @@ -169147,7 +169498,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -169223,9 +169574,9 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 package: description: Information about the package. type: object @@ -169587,7 +169938,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *858 + items: *859 source_url: type: string format: uri @@ -169658,7 +170009,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -169839,12 +170190,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *817 + enterprise: *818 id: type: integer - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - id @@ -169921,7 +170272,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &859 + personal_access_token_request: &860 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -170071,10 +170422,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *817 - organization: *819 + enterprise: *818 + organization: *820 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170151,11 +170502,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *859 - enterprise: *817 - organization: *819 + personal_access_token_request: *860 + enterprise: *818 + organization: *820 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170231,11 +170582,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *859 - enterprise: *817 - organization: *819 + personal_access_token_request: *860 + enterprise: *818 + organization: *820 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170310,11 +170661,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *859 - organization: *819 - enterprise: *817 + personal_access_token_request: *860 + organization: *820 + enterprise: *818 sender: *4 - installation: *818 + installation: *819 required: - action - personal_access_token_request @@ -170419,7 +170770,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *860 + last_response: *861 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -170451,8 +170802,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 zen: description: Random string of GitHub zen. @@ -170697,10 +171048,10 @@ webhooks: - from required: - note - enterprise: *817 - installation: *818 - organization: *819 - project_card: &861 + enterprise: *818 + installation: *819 + organization: *820 + project_card: &862 title: Project Card type: object properties: @@ -170823,7 +171174,7 @@ webhooks: - creator - created_at - updated_at - repository: *820 + repository: *821 sender: *4 required: - action @@ -170904,11 +171255,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - project_card: *861 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_card: *862 + repository: *821 sender: *4 required: - action @@ -170988,9 +171339,9 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 project_card: title: Project Card type: object @@ -171120,7 +171471,7 @@ webhooks: repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -171214,11 +171565,11 @@ webhooks: - from required: - note - enterprise: *817 - installation: *818 - organization: *819 - project_card: *861 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_card: *862 + repository: *821 sender: *4 required: - action @@ -171312,9 +171663,9 @@ webhooks: - from required: - column_id - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 project_card: allOf: - title: Project Card @@ -171511,7 +171862,7 @@ webhooks: type: string required: - after_id - repository: *820 + repository: *821 sender: *4 required: - action @@ -171591,10 +171942,10 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 - organization: *819 - project: &863 + enterprise: *818 + installation: *819 + organization: *820 + project: &864 title: Project type: object properties: @@ -171721,7 +172072,7 @@ webhooks: - creator - created_at - updated_at - repository: *820 + repository: *821 sender: *4 required: - action @@ -171801,10 +172152,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - project_column: &862 + enterprise: *818 + installation: *819 + organization: *820 + project_column: &863 title: Project Column type: object properties: @@ -171844,7 +172195,7 @@ webhooks: - name - created_at - updated_at - repository: *820 + repository: *821 sender: *4 required: - action @@ -171923,14 +172274,14 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - project_column: *862 + enterprise: *818 + installation: *819 + organization: *820 + project_column: *863 repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -172019,11 +172370,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - project_column: *862 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_column: *863 + repository: *821 sender: *4 required: - action @@ -172103,11 +172454,11 @@ webhooks: type: string enum: - moved - enterprise: *817 - installation: *818 - organization: *819 - project_column: *862 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project_column: *863 + repository: *821 sender: *4 required: - action @@ -172187,11 +172538,11 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - project: *863 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 + repository: *821 sender: *4 required: - action @@ -172271,14 +172622,14 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - project: *863 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 repository: anyOf: - type: 'null' - - *820 + - *821 sender: *4 required: - action @@ -172379,11 +172730,11 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - project: *863 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 + repository: *821 sender: *4 required: - action @@ -172462,11 +172813,11 @@ webhooks: type: string enum: - reopened - enterprise: *817 - installation: *818 - organization: *819 - project: *863 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + project: *864 + repository: *821 sender: *4 required: - action @@ -172547,8 +172898,8 @@ webhooks: type: string enum: - closed - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172630,8 +172981,8 @@ webhooks: type: string enum: - created - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172713,8 +173064,8 @@ webhooks: type: string enum: - deleted - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172836,8 +173187,8 @@ webhooks: type: string to: type: string - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -172921,7 +173272,7 @@ webhooks: type: string enum: - archived - changes: &867 + changes: &868 type: object properties: archived_at: @@ -172937,9 +173288,9 @@ webhooks: - string - 'null' format: date-time - installation: *818 - organization: *819 - projects_v2_item: &864 + installation: *819 + organization: *820 + projects_v2_item: &865 title: Projects v2 Item description: An item belonging to a project type: object @@ -173079,9 +173430,9 @@ webhooks: - 'null' to: type: string - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173163,9 +173514,9 @@ webhooks: type: string enum: - created - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173246,9 +173597,9 @@ webhooks: type: string enum: - deleted - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173353,7 +173704,7 @@ webhooks: oneOf: - type: string - type: integer - - &865 + - &866 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -173377,7 +173728,7 @@ webhooks: required: - id - name - - &866 + - &867 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -173417,8 +173768,8 @@ webhooks: oneOf: - type: string - type: integer - - *865 - *866 + - *867 type: - 'null' - string @@ -173441,9 +173792,9 @@ webhooks: - 'null' required: - body - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173540,9 +173891,9 @@ webhooks: type: - string - 'null' - installation: *818 - organization: *819 - projects_v2_item: *864 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173625,10 +173976,10 @@ webhooks: type: string enum: - restored - changes: *867 - installation: *818 - organization: *819 - projects_v2_item: *864 + changes: *868 + installation: *819 + organization: *820 + projects_v2_item: *865 sender: *4 required: - action @@ -173710,8 +174061,8 @@ webhooks: type: string enum: - reopened - installation: *818 - organization: *819 + installation: *819 + organization: *820 projects_v2: *378 sender: *4 required: @@ -173793,9 +174144,9 @@ webhooks: type: string enum: - created - installation: *818 - organization: *819 - projects_v2_status_update: *868 + installation: *819 + organization: *820 + projects_v2_status_update: *869 sender: *4 required: - action @@ -173876,9 +174227,9 @@ webhooks: type: string enum: - deleted - installation: *818 - organization: *819 - projects_v2_status_update: *868 + installation: *819 + organization: *820 + projects_v2_status_update: *869 sender: *4 required: - action @@ -174024,9 +174375,9 @@ webhooks: - string - 'null' format: date - installation: *818 - organization: *819 - projects_v2_status_update: *868 + installation: *819 + organization: *820 + projects_v2_status_update: *869 sender: *4 required: - action @@ -174097,10 +174448,10 @@ webhooks: title: public event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - repository @@ -174177,13 +174528,13 @@ webhooks: type: string enum: - assigned - assignee: *844 - enterprise: *817 - installation: *818 - number: &869 + assignee: *845 + enterprise: *818 + installation: *819 + number: &870 description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -176532,7 +176883,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -176614,11 +176965,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -178960,7 +179311,7 @@ webhooks: - draft reason: type: string - repository: *820 + repository: *821 sender: *4 required: - action @@ -179042,11 +179393,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -181388,7 +181739,7 @@ webhooks: - draft reason: type: string - repository: *820 + repository: *821 sender: *4 required: - action @@ -181470,13 +181821,13 @@ webhooks: type: string enum: - closed - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: &870 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: &871 allOf: - - *669 + - *670 - type: object properties: allow_auto_merge: @@ -181538,7 +181889,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *820 + repository: *821 sender: *4 required: - action @@ -181619,12 +181970,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -181704,11 +182055,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *817 + enterprise: *818 milestone: *381 - number: *869 - organization: *819 - pull_request: &871 + number: *870 + organization: *820 + pull_request: &872 title: Pull Request type: object properties: @@ -184035,7 +184386,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -184114,11 +184465,11 @@ webhooks: type: string enum: - dequeued - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -186464,7 +186815,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *820 + repository: *821 sender: *4 required: - action @@ -186588,12 +186939,12 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -186673,11 +187024,11 @@ webhooks: type: string enum: - enqueued - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -189008,7 +189359,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -189088,11 +189439,11 @@ webhooks: type: string enum: - labeled - enterprise: *817 - installation: *818 - label: *838 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + label: *839 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -191440,7 +191791,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -191521,10 +191872,10 @@ webhooks: type: string enum: - locked - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -193870,7 +194221,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -193950,12 +194301,12 @@ webhooks: type: string enum: - milestoned - enterprise: *817 + enterprise: *818 milestone: *381 - number: *869 - organization: *819 - pull_request: *871 - repository: *820 + number: *870 + organization: *820 + pull_request: *872 + repository: *821 sender: *4 required: - action @@ -194034,12 +194385,12 @@ webhooks: type: string enum: - opened - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -194120,12 +194471,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -194205,12 +194556,12 @@ webhooks: type: string enum: - reopened - enterprise: *817 - installation: *818 - number: *869 - organization: *819 - pull_request: *870 - repository: *820 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 + pull_request: *871 + repository: *821 sender: *4 required: - action @@ -194585,9 +194936,9 @@ webhooks: - start_side - side - reactions - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: type: object properties: @@ -196817,7 +197168,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *820 + repository: *821 sender: *4 required: - action @@ -196897,7 +197248,7 @@ webhooks: type: string enum: - deleted - comment: &873 + comment: &874 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -197190,9 +197541,9 @@ webhooks: - start_side - side - reactions - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: type: object properties: @@ -199410,7 +199761,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *820 + repository: *821 sender: *4 required: - action @@ -199490,11 +199841,11 @@ webhooks: type: string enum: - edited - changes: *872 - comment: *873 - enterprise: *817 - installation: *818 - organization: *819 + changes: *873 + comment: *874 + enterprise: *818 + installation: *819 + organization: *820 pull_request: type: object properties: @@ -201715,7 +202066,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *820 + repository: *821 sender: *4 required: - action @@ -201796,9 +202147,9 @@ webhooks: type: string enum: - dismissed - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -204031,7 +204382,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 + repository: *821 review: description: The review that was affected. type: object @@ -204282,9 +204633,9 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -206398,8 +206749,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 - review: &874 + repository: *821 + review: &875 description: The review that was affected. type: object properties: @@ -206637,12 +206988,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -208989,7 +209340,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_reviewer: title: User type: @@ -209075,12 +209426,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -211434,7 +211785,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211629,12 +211980,12 @@ webhooks: type: string enum: - review_requested - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -213983,7 +214334,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_reviewer: title: User type: @@ -214070,12 +214421,12 @@ webhooks: type: string enum: - review_requested - enterprise: *817 - installation: *818 + enterprise: *818 + installation: *819 number: description: The pull request number. type: integer - organization: *819 + organization: *820 pull_request: title: Pull Request type: object @@ -216415,7 +216766,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 requested_team: title: Team description: Groups of organization members that gives permissions @@ -216599,9 +216950,9 @@ webhooks: type: string enum: - submitted - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -218837,8 +219188,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 - review: *874 + repository: *821 + review: *875 sender: *4 required: - action @@ -218918,9 +219269,9 @@ webhooks: type: string enum: - resolved - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -221051,7 +221402,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 + repository: *821 sender: *4 thread: type: object @@ -221448,9 +221799,9 @@ webhooks: type: string enum: - unresolved - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 pull_request: title: Simple Pull Request type: object @@ -223564,7 +223915,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *820 + repository: *821 sender: *4 thread: type: object @@ -223963,10 +224314,10 @@ webhooks: type: string before: type: string - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -226301,7 +226652,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -226383,11 +226734,11 @@ webhooks: type: string enum: - unassigned - assignee: *875 - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + assignee: *876 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -228737,7 +229088,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -228816,11 +229167,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *817 - installation: *818 - label: *838 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + label: *839 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -231159,7 +231510,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -231240,10 +231591,10 @@ webhooks: type: string enum: - unlocked - enterprise: *817 - installation: *818 - number: *869 - organization: *819 + enterprise: *818 + installation: *819 + number: *870 + organization: *820 pull_request: title: Pull Request type: object @@ -233572,7 +233923,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *820 + repository: *821 sender: *4 required: - action @@ -233775,7 +234126,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *817 + enterprise: *818 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -233870,8 +234221,8 @@ webhooks: - url - author - committer - installation: *818 - organization: *819 + installation: *819 + organization: *820 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -234459,9 +234810,9 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 registry_package: type: object properties: @@ -234938,7 +235289,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *858 + items: *859 summary: type: string tag_name: @@ -234994,7 +235345,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -235072,9 +235423,9 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 registry_package: type: object properties: @@ -235386,7 +235737,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *858 + items: *859 summary: type: string tag_name: @@ -235436,7 +235787,7 @@ webhooks: - owner - package_version - registry - repository: *820 + repository: *821 sender: *4 required: - action @@ -235513,10 +235864,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - release: &876 + enterprise: *818 + installation: *819 + organization: *820 + release: &877 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -235847,7 +236198,7 @@ webhooks: - updated_at - zipball_url - body - repository: *820 + repository: *821 sender: *4 required: - action @@ -235924,11 +236275,11 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - release: *876 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *877 + repository: *821 sender: *4 required: - action @@ -236045,11 +236396,11 @@ webhooks: type: boolean required: - to - enterprise: *817 - installation: *818 - organization: *819 - release: *876 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *877 + repository: *821 sender: *4 required: - action @@ -236127,9 +236478,9 @@ webhooks: type: string enum: - prereleased - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -236465,7 +236816,7 @@ webhooks: - string - 'null' format: uri - repository: *820 + repository: *821 sender: *4 required: - action @@ -236541,10 +236892,10 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 - release: &877 + enterprise: *818 + installation: *819 + organization: *820 + release: &878 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -236877,7 +237228,7 @@ webhooks: - string - 'null' format: uri - repository: *820 + repository: *821 sender: *4 required: - action @@ -236953,11 +237304,11 @@ webhooks: type: string enum: - released - enterprise: *817 - installation: *818 - organization: *819 - release: *876 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *877 + repository: *821 sender: *4 required: - action @@ -237033,11 +237384,11 @@ webhooks: type: string enum: - unpublished - enterprise: *817 - installation: *818 - organization: *819 - release: *877 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + release: *878 + repository: *821 sender: *4 required: - action @@ -237113,11 +237464,11 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - repository_advisory: *722 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + repository_advisory: *723 sender: *4 required: - action @@ -237193,11 +237544,11 @@ webhooks: type: string enum: - reported - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - repository_advisory: *722 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + repository_advisory: *723 sender: *4 required: - action @@ -237273,10 +237624,10 @@ webhooks: type: string enum: - archived - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237353,10 +237704,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237434,10 +237785,10 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237522,10 +237873,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237640,10 +237991,10 @@ webhooks: - 'null' items: type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237715,10 +238066,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 status: type: string @@ -237799,10 +238150,10 @@ webhooks: type: string enum: - privatized - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237879,10 +238230,10 @@ webhooks: type: string enum: - publicized - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -237976,10 +238327,10 @@ webhooks: - name required: - repository - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -238059,10 +238410,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 repository_ruleset: *179 sender: *4 required: @@ -238141,10 +238492,10 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 repository_ruleset: *179 sender: *4 required: @@ -238223,10 +238574,10 @@ webhooks: type: string enum: - edited - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 repository_ruleset: *179 changes: type: object @@ -238288,16 +238639,16 @@ webhooks: properties: added: type: array - items: *690 + items: *691 deleted: type: array - items: *690 + items: *691 updated: type: array items: type: object properties: - rule: *690 + rule: *691 changes: type: object properties: @@ -238534,10 +238885,10 @@ webhooks: - from required: - owner - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -238615,10 +238966,10 @@ webhooks: type: string enum: - unarchived - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -238696,7 +239047,7 @@ webhooks: type: string enum: - create - alert: &878 + alert: &879 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -238820,10 +239171,10 @@ webhooks: type: string enum: - open - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239033,10 +239384,10 @@ webhooks: type: string enum: - dismissed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239114,11 +239465,11 @@ webhooks: type: string enum: - reopen - alert: *878 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *879 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239320,10 +239671,10 @@ webhooks: enum: - fixed - open - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239341,7 +239692,7 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -239349,8 +239700,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -239394,14 +239745,14 @@ webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &879 + - assigned + alert: &880 type: object properties: number: *119 @@ -239515,10 +239866,93 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + assignee: *4 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-created: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was created. + operationId: secret-scanning-alert/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239599,11 +240033,11 @@ webhooks: type: string enum: - created - alert: *879 - installation: *818 - location: *880 - organization: *819 - repository: *820 + alert: *880 + installation: *819 + location: *881 + organization: *820 + repository: *821 sender: *4 required: - location @@ -239841,11 +240275,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -239923,11 +240357,11 @@ webhooks: type: string enum: - reopened - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -240005,11 +240439,94 @@ webhooks: type: string enum: - resolved - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *880 + assignee: *4 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -240087,11 +240604,11 @@ webhooks: type: string enum: - validated - alert: *879 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + alert: *880 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -240221,10 +240738,10 @@ webhooks: - organization - enterprise - - repository: *820 - enterprise: *817 - installation: *818 - organization: *819 + repository: *821 + enterprise: *818 + installation: *819 + organization: *820 sender: *4 required: - action @@ -240302,11 +240819,11 @@ webhooks: type: string enum: - published - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - security_advisory: &881 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + security_advisory: &882 description: The details of the security advisory, including summary, description, and severity. type: object @@ -240492,11 +241009,11 @@ webhooks: type: string enum: - updated - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 - security_advisory: *881 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 + security_advisory: *882 sender: *4 required: - action @@ -240569,10 +241086,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -240759,10 +241276,10 @@ webhooks: type: object properties: security_and_analysis: *391 - enterprise: *817 - installation: *818 - organization: *819 - repository: *449 + enterprise: *818 + installation: *819 + organization: *820 + repository: *450 sender: *4 required: - changes @@ -240840,12 +241357,12 @@ webhooks: type: string enum: - cancelled - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: &882 + sponsorship: &883 type: object properties: created_at: @@ -241150,12 +241667,12 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - sponsorship @@ -241243,12 +241760,12 @@ webhooks: type: string required: - from - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - changes @@ -241325,17 +241842,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &883 + effective_date: &884 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - sponsorship @@ -241409,7 +241926,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &884 + changes: &885 type: object properties: tier: @@ -241453,13 +241970,13 @@ webhooks: - from required: - tier - effective_date: *883 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + effective_date: *884 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - changes @@ -241536,13 +242053,13 @@ webhooks: type: string enum: - tier_changed - changes: *884 - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + changes: *885 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - sponsorship: *882 + sponsorship: *883 required: - action - changes @@ -241616,10 +242133,10 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -241703,10 +242220,10 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242140,15 +242657,15 @@ webhooks: type: - string - 'null' - enterprise: *817 + enterprise: *818 id: description: The unique identifier of the status. type: integer - installation: *818 + installation: *819 name: type: string - organization: *819 - repository: *820 + organization: *820 + repository: *821 sender: *4 sha: description: The Commit SHA. @@ -242264,9 +242781,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242356,9 +242873,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242448,9 +242965,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242540,9 +243057,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *219 - installation: *818 - organization: *819 - repository: *820 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -242619,12 +243136,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - team: &885 + team: &886 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -242854,9 +243371,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -243326,7 +243843,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -243402,9 +243919,9 @@ webhooks: type: string enum: - created - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -243874,7 +244391,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -243951,9 +244468,9 @@ webhooks: type: string enum: - deleted - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -244423,7 +244940,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -244567,9 +245084,9 @@ webhooks: - from required: - permissions - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -245039,7 +245556,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - changes @@ -245117,9 +245634,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *817 - installation: *818 - organization: *819 + enterprise: *818 + installation: *819 + organization: *820 repository: title: Repository description: A git repository @@ -245589,7 +246106,7 @@ webhooks: - topics - visibility sender: *4 - team: *885 + team: *886 required: - action - team @@ -245665,10 +246182,10 @@ webhooks: type: string enum: - started - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 required: - action @@ -245741,17 +246258,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *817 + enterprise: *818 inputs: type: - object - 'null' additionalProperties: true - installation: *818 - organization: *819 + installation: *819 + organization: *820 ref: type: string - repository: *820 + repository: *821 sender: *4 workflow: type: string @@ -245833,10 +246350,10 @@ webhooks: type: string enum: - completed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: allOf: @@ -246092,7 +246609,7 @@ webhooks: type: string required: - conclusion - deployment: *576 + deployment: *577 required: - action - repository @@ -246171,10 +246688,10 @@ webhooks: type: string enum: - in_progress - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: allOf: @@ -246456,7 +246973,7 @@ webhooks: required: - status - steps - deployment: *576 + deployment: *577 required: - action - repository @@ -246535,10 +247052,10 @@ webhooks: type: string enum: - queued - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: type: object @@ -246684,7 +247201,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *576 + deployment: *577 required: - action - repository @@ -246763,10 +247280,10 @@ webhooks: type: string enum: - waiting - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 workflow_job: type: object @@ -246913,7 +247430,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *576 + deployment: *577 required: - action - repository @@ -246993,12 +247510,12 @@ webhooks: type: string enum: - completed - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Workflow Run type: object @@ -248017,12 +248534,12 @@ webhooks: type: string enum: - in_progress - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Workflow Run type: object @@ -249026,12 +249543,12 @@ webhooks: type: string enum: - requested - enterprise: *817 - installation: *818 - organization: *819 - repository: *820 + enterprise: *818 + installation: *819 + organization: *820 + repository: *821 sender: *4 - workflow: *834 + workflow: *835 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 47ac630b6..2f8560e88 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -11608,6 +11608,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -37976,6 +37979,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75284,6 +75290,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75410,7 +75419,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -75445,6 +75454,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -75452,6 +75464,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -75461,6 +75478,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -75489,7 +75518,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -91030,6 +91059,201 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -114557,6 +114781,99 @@ } } }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", @@ -114852,11 +115169,104 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -114923,7 +115333,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -114945,11 +115355,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -115016,7 +115426,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -119789,6 +120199,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -157668,6 +158086,13 @@ "null" ] }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] + }, "secret-scanning-location": { "type": "object", "properties": { @@ -178123,6 +178548,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -178956,6 +179388,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -297474,6 +297913,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -297663,6 +298140,44 @@ "repository" ] }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", @@ -313535,7 +314050,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } }, "delete-budget": { @@ -319526,21 +320056,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -335452,7 +336000,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } }, "secret-scanning-location-list": { @@ -340572,6 +341140,194 @@ } } }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "user-received-events-items": { "value": [ { @@ -342875,6 +343631,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "secret-scanning-alert-sort": { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index e3a7ef585..9cafd4822 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -8304,6 +8304,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" @@ -27348,6 +27349,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -54417,6 +54419,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -54496,6 +54499,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -54522,14 +54527,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -54547,7 +54564,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -65720,6 +65738,144 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -82470,6 +82626,72 @@ webhooks: supported-webhook-types: - repository - organization + secret-scanning-alert-assigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-assigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-created: post: summary: |- @@ -82813,6 +83035,72 @@ webhooks: - repository - organization - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-unassigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-validated: post: summary: |- @@ -86226,6 +86514,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -113995,6 +114290,12 @@ components: type: - string - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: + - string + - 'null' secret-scanning-location: type: object properties: @@ -129081,6 +129382,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -129709,6 +130015,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -217813,6 +218124,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -217944,6 +218281,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -230488,7 +230851,19 @@ components: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -235607,17 +235982,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -249314,6 +249701,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-location-list: value: - type: commit @@ -253667,6 +254073,138 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' user-received-events-items: value: - id: '22249084964' @@ -255728,6 +256266,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 47ac630b6..2f8560e88 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -11608,6 +11608,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -37976,6 +37979,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75284,6 +75290,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75410,7 +75419,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -75445,6 +75454,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -75452,6 +75464,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -75461,6 +75478,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -75489,7 +75518,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -91030,6 +91059,201 @@ "category": "projects", "subcategory": "fields" } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date", + "single_select", + "iteration" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title for the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type" + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } } }, "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { @@ -114557,6 +114781,99 @@ } } }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "secret-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", @@ -114852,11 +115169,104 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-secret-scanning-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-resolved": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -114923,7 +115333,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -114945,11 +115355,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -115016,7 +115426,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -119789,6 +120199,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -157668,6 +158086,13 @@ "null" ] }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] + }, "secret-scanning-location": { "type": "object", "properties": { @@ -178123,6 +178548,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -178956,6 +179388,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -297474,6 +297913,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -297663,6 +298140,44 @@ "repository" ] }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", @@ -313535,7 +314050,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } }, "delete-budget": { @@ -319526,21 +320056,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -335452,7 +336000,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } }, "secret-scanning-location-list": { @@ -340572,6 +341140,194 @@ } } }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "user-received-events-items": { "value": [ { @@ -342875,6 +343631,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "secret-scanning-alert-sort": { "name": "sort", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index e3a7ef585..9cafd4822 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -8304,6 +8304,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" @@ -27348,6 +27349,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -54417,6 +54419,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -54496,6 +54499,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -54522,14 +54527,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -54547,7 +54564,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -65720,6 +65738,144 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + - single_select + - iteration + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + iteration_configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title for the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -82470,6 +82626,72 @@ webhooks: supported-webhook-types: - repository - organization + secret-scanning-alert-assigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-assigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-created: post: summary: |- @@ -82813,6 +83035,72 @@ webhooks: - repository - organization - app + secret-scanning-alert-unassigned: + post: + summary: |- + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + 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-secret-scanning-alert-unassigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-validated: post: summary: |- @@ -86226,6 +86514,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -113995,6 +114290,12 @@ components: type: - string - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: + - string + - 'null' secret-scanning-location: type: object properties: @@ -129081,6 +129382,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -129709,6 +130015,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -217813,6 +218124,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -217944,6 +218281,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -230488,7 +230851,19 @@ components: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -235607,17 +235982,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -249314,6 +249701,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false secret-scanning-location-list: value: - type: commit @@ -253667,6 +254073,138 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' user-received-events-items: value: - id: '22249084964' @@ -255728,6 +256266,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index ba66cd28c..4c7ed76a3 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -4336,6 +4336,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -5766,6 +5774,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6729,6 +6745,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12453,6 +12477,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13568,6 +13600,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -14456,6 +14496,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -14909,6 +14957,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -18095,6 +18151,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -19242,6 +19306,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -20253,6 +20325,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -20967,6 +21047,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -22718,6 +22806,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -23873,6 +23969,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -25103,6 +25207,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -26074,6 +26186,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -27282,6 +27402,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -28253,6 +28381,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -29335,6 +29471,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -30456,6 +30600,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -110202,6 +110354,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -111332,6 +111492,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -311149,6 +311317,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -453199,9 +453375,6 @@ "state" ] } - ], - "required": [ - "state" ] }, "examples": { @@ -501128,6 +501301,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -549055,6 +549236,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -613869,6 +614058,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -616664,6 +616860,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -745785,6 +745988,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -748891,6 +749102,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -751902,6 +752121,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -754913,6 +755140,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -758058,6 +758293,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -761210,6 +761453,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", +{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}