diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 729ba38e5..b1b82f4f3 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -7885,10 +7885,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -26651,6 +26648,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61772,6 +61772,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61898,7 +61901,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" @@ -61933,6 +61936,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -61940,6 +61946,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -61949,6 +61960,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -61977,7 +62000,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" @@ -75526,6 +75549,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}": { @@ -97274,6 +97492,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.", @@ -97569,11 +97880,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" }, @@ -97640,7 +98044,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -97662,11 +98066,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" }, @@ -97733,7 +98137,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102256,6 +102660,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.", @@ -123062,6 +123474,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -133385,6 +133798,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -152099,6 +152517,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -152902,6 +153327,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -266659,6 +267091,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", @@ -266848,6 +267318,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", @@ -281834,6 +282342,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.", @@ -286560,21 +287089,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", @@ -302541,7 +303088,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": { @@ -307305,6 +307872,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": [ { @@ -310249,6 +311004,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index ba0ae443b..aa298c424 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -5581,9 +5581,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': @@ -19274,6 +19272,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" @@ -44849,6 +44848,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" @@ -44928,6 +44928,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. @@ -44954,14 +44956,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 @@ -44979,7 +44993,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: @@ -54766,6 +54781,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 @@ -70248,6 +70401,72 @@ x-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: |- @@ -70591,6 +70810,72 @@ x-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: |- @@ -73879,6 +74164,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 @@ -90452,6 +90744,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -98269,6 +98562,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -112551,6 +112849,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113164,6 +113467,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -198804,6 +199112,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 @@ -198935,6 +199269,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 @@ -211134,6 +211494,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. @@ -215080,17 +215456,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: @@ -228856,6 +229244,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 @@ -232967,6 +233374,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' @@ -235567,6 +236106,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 729ba38e5..b1b82f4f3 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -7885,10 +7885,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -26651,6 +26648,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61772,6 +61772,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61898,7 +61901,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" @@ -61933,6 +61936,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -61940,6 +61946,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -61949,6 +61960,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -61977,7 +62000,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" @@ -75526,6 +75549,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}": { @@ -97274,6 +97492,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.", @@ -97569,11 +97880,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" }, @@ -97640,7 +98044,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -97662,11 +98066,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" }, @@ -97733,7 +98137,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102256,6 +102660,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.", @@ -123062,6 +123474,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -133385,6 +133798,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -152099,6 +152517,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -152902,6 +153327,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -266659,6 +267091,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", @@ -266848,6 +267318,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", @@ -281834,6 +282342,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.", @@ -286560,21 +287089,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", @@ -302541,7 +303088,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": { @@ -307305,6 +307872,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": [ { @@ -310249,6 +311004,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index ba0ae443b..aa298c424 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -5581,9 +5581,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': @@ -19274,6 +19272,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" @@ -44849,6 +44848,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" @@ -44928,6 +44928,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. @@ -44954,14 +44956,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 @@ -44979,7 +44993,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: @@ -54766,6 +54781,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 @@ -70248,6 +70401,72 @@ x-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: |- @@ -70591,6 +70810,72 @@ x-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: |- @@ -73879,6 +74164,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 @@ -90452,6 +90744,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -98269,6 +98562,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -112551,6 +112849,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113164,6 +113467,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -198804,6 +199112,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 @@ -198935,6 +199269,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 @@ -211134,6 +211494,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. @@ -215080,17 +215456,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: @@ -228856,6 +229244,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 @@ -232967,6 +233374,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' @@ -235567,6 +236106,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 5a35ecf80..48d2c605f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -4718,6 +4718,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.", @@ -5703,6 +5711,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.", @@ -6542,6 +6558,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.", @@ -7012,6 +7036,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.", @@ -9037,6 +9069,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.", @@ -10073,6 +10113,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.", @@ -11026,6 +11074,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.", @@ -11690,6 +11746,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.", @@ -54329,7 +54393,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" + ] + } + } } } } @@ -102968,6 +103047,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.", @@ -103968,6 +104055,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.", @@ -139240,21 +139335,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", @@ -168149,6 +168262,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.", @@ -224334,6 +224470,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224354,6 +224491,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242552,6 +242690,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242572,6 +242711,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278220,6 +278360,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278240,6 +278381,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283974,6 +284116,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283994,6 +284137,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289303,6 +289447,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289323,6 +289468,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289849,6 +289995,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289869,6 +290016,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290419,6 +290567,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290439,6 +290588,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -324211,6 +324361,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.", @@ -406452,6 +406610,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -406472,6 +406631,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437285,6 +437445,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437305,6 +437466,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -468363,6 +468525,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.", @@ -470603,7 +470788,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" @@ -470673,6 +470858,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -470680,6 +470870,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -470689,6 +470884,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -471665,7 +471872,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 + } } } } @@ -471679,7 +471906,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", @@ -498900,6 +499127,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -499112,6 +499340,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -540360,6 +540589,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.", @@ -589101,6 +589338,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.", @@ -595498,51 +595743,720 @@ "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { @@ -595743,21 +596657,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", @@ -647113,6 +648045,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -649494,6 +650433,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -757124,6 +758070,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.", @@ -759716,6 +760670,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.", @@ -762215,6 +763177,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.", @@ -764714,6 +765684,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.", @@ -767345,6 +768323,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.", @@ -769983,6 +770969,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.", @@ -774244,6 +775238,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.", @@ -1169291,200 +1170293,3589 @@ "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1170992,7 +1175383,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1171008,23 +1175399,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": [ { @@ -1171089,15 +1175478,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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).\"", @@ -1172604,6 +1177169,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1172619,21 +1177185,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" }, @@ -1172700,13 +1177264,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": { @@ -1174405,11 +1178969,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" }, @@ -1174476,13 +1179040,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": { @@ -1174493,9 +1179057,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1174515,10 +1179076,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1174614,9 +1179171,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1174656,7 +1179210,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1176163,279 +1180718,855 @@ "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": { + "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, + "nullable": 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", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1177944,8 +1183075,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1177959,21 +1183089,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": [ { @@ -1178038,179 +1183169,630 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1179721,8 +1185303,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1179736,21 +1185317,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": [ { @@ -1179815,7 +1185397,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1180442,74 +1186024,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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1180531,6 +1186045,314 @@ "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.", + "example": "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", + "example": "/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", + "example": "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", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", @@ -1181947,10 +1187769,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" + } + } } } } @@ -1181962,8 +1187959,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1181972,13 +1187970,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": [ { @@ -1182043,13 +1188041,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": { @@ -1182670,6 +1188668,74 @@ } } }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1182691,314 +1188757,6 @@ "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.", - "example": "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", - "example": "/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", - "example": "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", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", @@ -1184415,185 +1190173,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" - } - } } } } @@ -1184605,9 +1190188,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1184616,11 +1190198,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" }, @@ -1184687,13 +1190269,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": { @@ -1186844,11 +1192426,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" }, @@ -1186915,13 +1192497,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": { @@ -1189072,11 +1194654,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" }, @@ -1189143,13 +1194725,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": { @@ -1189770,6 +1195352,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e26d2a991..3778c635d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1023,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &638 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -2208,6 +2208,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 @@ -10675,7 +10682,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &649 + sub_issues_summary: &650 title: Sub-issues Summary type: object properties: @@ -10695,7 +10702,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &650 + issue_dependencies_summary: &651 title: Issue Dependencies Summary type: object properties: @@ -10714,7 +10721,7 @@ paths: - total_blocking issue_field_values: type: array - items: &651 + items: &652 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11365,7 +11372,7 @@ paths: url: type: string format: uri - user: &663 + user: &664 title: Public User description: Public User type: object @@ -16585,7 +16592,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': *25 '403': *29 @@ -16716,7 +16735,7 @@ paths: required: false schema: type: string - - &702 + - &703 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -16862,7 +16881,7 @@ paths: parameters: - *63 - *106 - - &703 + - &704 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 @@ -16974,7 +16993,7 @@ paths: - *106 - *108 - *107 - - &704 + - &705 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -16982,7 +17001,7 @@ paths: schema: type: string - *109 - - &705 + - &706 name: sku description: The SKU to query for usage. in: query @@ -20546,7 +20565,7 @@ paths: type: array items: *143 examples: - default: &666 + default: &667 value: total_count: 1 repositories: @@ -23442,12 +23461,12 @@ paths: required: - subject_digests examples: - default: &694 + default: &695 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &695 + withPredicateType: &696 value: subject_digests: - sha256:abc123 @@ -23505,7 +23524,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &696 + default: &697 value: attestations_subject_digests: - sha256:abc: @@ -33071,7 +33090,7 @@ paths: parameters: - *63 - *231 - - &679 + - &680 name: repo_name description: repo_name parameter in: path @@ -34110,7 +34129,7 @@ paths: - nuget - container - *63 - - &680 + - &681 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34151,7 +34170,7 @@ paths: default: *238 '403': *29 '401': *25 - '400': &682 + '400': &683 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35943,7 +35962,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &756 + properties: &757 id: type: number description: The unique identifier of the status update. @@ -35991,7 +36010,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &757 + required: &758 - id - node_id - created_at @@ -36809,7 +36828,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &700 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36941,7 +36960,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *255 - - &700 + - &701 name: field_id description: The unique identifier of the field. in: path @@ -36956,7 +36975,7 @@ paths: application/json: schema: *259 examples: - default: &701 + default: &702 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36965,17 +36984,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: @@ -41810,6 +41841,25 @@ paths: schema: type: string - &608 + 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 + - &609 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. @@ -41824,7 +41874,7 @@ paths: - *48 - *19 - *17 - - &609 + - &610 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 @@ -41834,7 +41884,7 @@ paths: required: false schema: type: string - - &610 + - &611 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 @@ -41844,7 +41894,7 @@ paths: required: false schema: type: string - - &611 + - &612 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41853,7 +41903,7 @@ paths: required: false schema: type: string - - &612 + - &613 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41862,7 +41912,7 @@ paths: schema: type: boolean default: false - - &613 + - &614 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41871,7 +41921,7 @@ paths: schema: type: boolean default: false - - &614 + - &615 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41906,14 +41956,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &616 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: &616 + resolution: &617 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -42020,8 +42070,8 @@ paths: pull request. ' - oneOf: &617 - - &619 + oneOf: &618 + - &620 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42073,7 +42123,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &621 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. @@ -42128,7 +42178,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &622 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42142,7 +42192,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &622 + - &623 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42156,7 +42206,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &623 + - &624 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42170,7 +42220,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &624 + - &625 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42184,7 +42234,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &626 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42198,7 +42248,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &627 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42212,7 +42262,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &628 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. @@ -42226,7 +42276,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &628 + - &629 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. @@ -42240,7 +42290,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &629 + - &630 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. @@ -42254,7 +42304,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &630 + - &631 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. @@ -42268,7 +42318,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &631 + - &632 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. @@ -42766,7 +42816,7 @@ paths: application/json: schema: type: array - items: &635 + items: &636 description: A repository security advisory. type: object properties: @@ -43057,7 +43107,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &637 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44968,7 +45018,7 @@ paths: - updated_at - url examples: - default: &653 + default: &654 value: - author: login: octocat @@ -45216,7 +45266,7 @@ paths: application/json: schema: *314 examples: - default: &654 + default: &655 value: author: login: octocat @@ -45399,7 +45449,7 @@ paths: - updated_at - url examples: - default: &655 + default: &656 value: - author: login: octocat @@ -45625,7 +45675,7 @@ paths: application/json: schema: *317 examples: - default: &656 + default: &657 value: author: login: octocat @@ -46241,7 +46291,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &657 + response-if-user-is-a-team-maintainer: &658 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46306,7 +46356,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: &658 + response-if-users-membership-with-team-is-now-pending: &659 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46447,7 +46497,7 @@ paths: - updated_at - permissions examples: - default: &659 + default: &660 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46526,7 +46576,7 @@ paths: application/json: schema: *325 examples: - default: &660 + default: &661 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46736,7 +46786,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &661 + schema: &662 title: Team Repository description: A team's access to a repository. type: object @@ -47393,7 +47443,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: &662 + response-if-child-teams-exist: &663 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -55356,6 +55406,7 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: @@ -58569,7 +58620,7 @@ paths: check. type: array items: *406 - deployment: &714 + deployment: &715 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -59481,7 +59532,7 @@ paths: type: string format: date-time nullable: true - head_commit: &740 + head_commit: &741 title: Simple Commit description: A commit. type: object @@ -63714,14 +63765,14 @@ paths: type: integer machines: type: array - items: &669 + items: &670 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *448 required: *449 examples: - default: &670 + default: &671 value: total_count: 2 machines: @@ -66731,7 +66782,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Status description: The status of a commit. type: object @@ -68287,7 +68338,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &633 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -74021,7 +74072,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &748 + last_response: &749 title: Hook Response type: object properties: @@ -75072,7 +75123,7 @@ paths: parameters: - *327 - *328 - - &691 + - &692 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75506,7 +75557,7 @@ paths: type: array items: *522 examples: - default: &684 + default: &685 value: - id: 1 repository: @@ -89281,15 +89332,16 @@ paths: - *606 - *607 - *608 + - *609 - *48 - *19 - *17 - - *609 - *610 - *611 - *612 - *613 - *614 + - *615 responses: '200': description: Response @@ -89297,7 +89349,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 type: object properties: number: *161 @@ -89316,8 +89368,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolved_at: type: string format: date-time @@ -89413,7 +89465,7 @@ paths: pull request. ' - oneOf: *617 + oneOf: *618 nullable: true has_more_locations: type: boolean @@ -89565,13 +89617,13 @@ paths: - *327 - *328 - *427 - - *614 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -89613,6 +89665,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. @@ -89633,27 +89687,42 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *618 + schema: *619 examples: default: value: @@ -89698,6 +89767,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. @@ -89705,7 +89793,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': *104 x-github: enabledForGitHubApps: true @@ -89741,7 +89830,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &771 type: object properties: type: @@ -89767,7 +89856,6 @@ paths: example: commit details: oneOf: - - *619 - *620 - *621 - *622 @@ -89780,6 +89868,7 @@ paths: - *629 - *630 - *631 + - *632 examples: default: value: @@ -89874,14 +89963,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &634 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *633 required: - reason - placeholder_id @@ -89898,7 +89987,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *634 expire_at: type: string format: date-time @@ -89960,7 +90049,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &635 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89986,15 +90075,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *634 + items: *635 backfill_scans: type: array - items: *634 + items: *635 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *635 - type: object properties: pattern_name: @@ -90109,9 +90198,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *636 + default: *637 '400': *14 '404': *6 x-github: @@ -90295,9 +90384,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: &638 + default: &639 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90635,7 +90724,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -90784,15 +90873,15 @@ paths: parameters: - *327 - *328 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 + default: *639 '403': *29 '404': *6 x-github: @@ -90818,7 +90907,7 @@ paths: parameters: - *327 - *328 - - *637 + - *638 requestBody: required: true content: @@ -90977,10 +91066,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 - add_credit: *638 + default: *639 + add_credit: *639 '403': *29 '404': *6 '422': @@ -91020,7 +91109,7 @@ paths: parameters: - *327 - *328 - - *637 + - *638 responses: '202': *39 '400': *14 @@ -91049,7 +91138,7 @@ paths: parameters: - *327 - *328 - - *637 + - *638 responses: '202': description: Response @@ -91193,7 +91282,7 @@ paths: application/json: schema: type: array - items: &639 + items: &640 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91566,7 +91655,7 @@ paths: application/json: schema: type: array - items: *639 + items: *640 examples: default: value: @@ -91654,7 +91743,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -91748,7 +91837,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &642 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91843,7 +91932,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -91980,7 +92069,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 title: Tag protection description: Tag protection type: object @@ -92056,7 +92145,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -92204,7 +92293,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92216,7 +92305,7 @@ paths: required: - names examples: - default: &644 + default: &645 value: names: - octocat @@ -92271,9 +92360,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 '404': *6 '422': *7 x-github: @@ -92296,7 +92385,7 @@ paths: parameters: - *327 - *328 - - &645 + - &646 name: per description: The time frame to display results for. in: query @@ -92325,7 +92414,7 @@ paths: example: 128 clones: type: array - items: &646 + items: &647 title: Traffic type: object properties: @@ -92566,7 +92655,7 @@ paths: parameters: - *327 - *328 - - *645 + - *646 responses: '200': description: Response @@ -92585,7 +92674,7 @@ paths: example: 3782 views: type: array - items: *646 + items: *647 required: - uniques - count @@ -93354,7 +93443,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &647 + text_matches: &648 title: Search Result Text Matches type: array items: @@ -93516,7 +93605,7 @@ paths: enum: - author-date - committer-date - - &648 + - &649 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 @@ -93644,7 +93733,7 @@ paths: type: number node_id: type: string - text_matches: *647 + text_matches: *648 required: - sha - node_id @@ -93836,7 +93925,7 @@ paths: - interactions - created - updated - - *648 + - *649 - *17 - *19 - name: advanced_search @@ -93933,11 +94022,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: type: string state_reason: @@ -93969,7 +94058,7 @@ paths: type: string format: date-time nullable: true - text_matches: *647 + text_matches: *648 pull_request: type: object properties: @@ -94194,7 +94283,7 @@ paths: enum: - created - updated - - *648 + - *649 - *17 - *19 responses: @@ -94238,7 +94327,7 @@ paths: nullable: true score: type: number - text_matches: *647 + text_matches: *648 required: - id - node_id @@ -94323,7 +94412,7 @@ paths: - forks - help-wanted-issues - updated - - *648 + - *649 - *17 - *19 responses: @@ -94562,7 +94651,7 @@ paths: - admin - pull - push - text_matches: *647 + text_matches: *648 temp_clone_token: type: string allow_merge_commit: @@ -94862,7 +94951,7 @@ paths: type: string format: uri nullable: true - text_matches: *647 + text_matches: *648 related: type: array nullable: true @@ -95053,7 +95142,7 @@ paths: - followers - repositories - joined - - *648 + - *649 - *17 - *19 responses: @@ -95157,7 +95246,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *647 + text_matches: *648 blog: type: string nullable: true @@ -95236,7 +95325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &652 + - &653 name: team_id description: The unique identifier of the team. in: path @@ -95277,7 +95366,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *652 + - *653 requestBody: required: true content: @@ -95377,7 +95466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *652 + - *653 responses: '204': description: Response @@ -95408,7 +95497,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *652 + - *653 - *48 - *17 - *19 @@ -95421,7 +95510,7 @@ paths: type: array items: *314 examples: - default: *653 + default: *654 headers: Link: *54 x-github: @@ -95450,7 +95539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *652 + - *653 requestBody: required: true content: @@ -95513,7 +95602,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *652 + - *653 - *316 responses: '200': @@ -95547,7 +95636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *652 + - *653 - *316 requestBody: required: false @@ -95573,7 +95662,7 @@ paths: application/json: schema: *314 examples: - default: *654 + default: *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95598,7 +95687,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *652 + - *653 - *316 responses: '204': @@ -95628,7 +95717,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *652 + - *653 - *316 - *48 - *17 @@ -95642,7 +95731,7 @@ paths: type: array items: *317 examples: - default: *655 + default: *656 headers: Link: *54 x-github: @@ -95671,7 +95760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 requestBody: required: true @@ -95723,7 +95812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 responses: @@ -95758,7 +95847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 requestBody: @@ -95784,7 +95873,7 @@ paths: application/json: schema: *317 examples: - default: *656 + default: *657 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95809,7 +95898,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 responses: @@ -95840,7 +95929,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 - name: content @@ -95899,7 +95988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 requestBody: @@ -95961,7 +96050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *652 + - *653 - *316 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -96019,7 +96108,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *652 + - *653 - *316 requestBody: required: true @@ -96078,7 +96167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96116,7 +96205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *652 + - *653 - name: role description: Filters members returned by their role in the team. in: query @@ -96167,7 +96256,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96204,7 +96293,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96244,7 +96333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96281,7 +96370,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *652 + - *653 - *59 responses: '200': @@ -96290,7 +96379,7 @@ paths: application/json: schema: *324 examples: - response-if-user-is-a-team-maintainer: *657 + response-if-user-is-a-team-maintainer: *658 '404': *6 x-github: githubCloudOnly: false @@ -96323,7 +96412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *652 + - *653 - *59 requestBody: required: false @@ -96351,7 +96440,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: *658 + response-if-users-membership-with-team-is-now-pending: *659 '403': description: Forbidden if team synchronization is set up '422': @@ -96385,7 +96474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96414,7 +96503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96426,7 +96515,7 @@ paths: type: array items: *325 examples: - default: *659 + default: *660 headers: Link: *54 '404': *6 @@ -96452,7 +96541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *652 + - *653 - *326 responses: '200': @@ -96461,7 +96550,7 @@ paths: application/json: schema: *325 examples: - default: *660 + default: *661 '404': description: Not Found if project is not managed by this team x-github: @@ -96485,7 +96574,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *652 + - *653 - *326 requestBody: required: false @@ -96553,7 +96642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *652 + - *653 - *326 responses: '204': @@ -96581,7 +96670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96623,7 +96712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *652 + - *653 - *327 - *328 responses: @@ -96631,7 +96720,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *661 + schema: *662 examples: alternative-response-with-extra-repository-information: value: @@ -96782,7 +96871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *652 + - *653 - *327 - *328 requestBody: @@ -96834,7 +96923,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *652 + - *653 - *327 - *328 responses: @@ -96861,7 +96950,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96873,7 +96962,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: *662 + response-if-child-teams-exist: *663 headers: Link: *54 '404': *6 @@ -96906,7 +96995,7 @@ paths: application/json: schema: oneOf: - - &664 + - &665 title: Private User description: Private User type: object @@ -97109,7 +97198,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *663 + - *664 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97262,7 +97351,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *665 examples: default: value: @@ -97660,7 +97749,7 @@ paths: type: integer secrets: type: array - items: &665 + items: &666 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97776,7 +97865,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: default: value: @@ -97922,7 +98011,7 @@ paths: type: array items: *143 examples: - default: *666 + default: *667 '401': *25 '403': *29 '404': *6 @@ -98189,7 +98278,7 @@ paths: description: Response content: application/json: - schema: &667 + schema: &668 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98230,7 +98319,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &668 + default: &669 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98275,9 +98364,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: - default: *668 + default: *669 '404': *6 x-github: githubCloudOnly: false @@ -98314,9 +98403,9 @@ paths: type: integer machines: type: array - items: *669 + items: *670 examples: - default: *670 + default: *671 '304': *37 '500': *103 '401': *25 @@ -99255,7 +99344,7 @@ paths: type: array items: *237 examples: - default: &681 + default: &682 value: - id: 197 name: hello_docker @@ -99356,7 +99445,7 @@ paths: application/json: schema: type: array - items: &671 + items: &672 title: Email description: Email type: object @@ -99421,9 +99510,9 @@ paths: application/json: schema: type: array - items: *671 + items: *672 examples: - default: &683 + default: &684 value: - email: octocat@github.com verified: true @@ -99498,7 +99587,7 @@ paths: application/json: schema: type: array - items: *671 + items: *672 examples: default: value: @@ -99754,7 +99843,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: GPG Key description: A unique encryption key type: object @@ -99885,7 +99974,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -99970,9 +100059,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: id: 3 name: Octocat's GPG Key @@ -100029,7 +100118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &674 + - &675 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100041,9 +100130,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 '304': *37 '403': *29 @@ -100066,7 +100155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *674 + - *675 responses: '204': description: Response @@ -100521,7 +100610,7 @@ paths: application/json: schema: type: array - items: &675 + items: &676 title: Key description: Key type: object @@ -100622,9 +100711,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *676 examples: - default: &676 + default: &677 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100663,9 +100752,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *676 examples: - default: *676 + default: *677 '404': *6 '304': *37 '403': *29 @@ -100721,7 +100810,7 @@ paths: application/json: schema: type: array - items: &677 + items: &678 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100789,7 +100878,7 @@ paths: - account - plan examples: - default: &678 + default: &679 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100851,9 +100940,9 @@ paths: application/json: schema: type: array - items: *677 + items: *678 examples: - default: *678 + default: *679 headers: Link: *54 '304': *37 @@ -101848,7 +101937,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *231 - - *679 + - *680 responses: '204': description: Response @@ -101963,7 +102052,7 @@ paths: - docker - nuget - container - - *680 + - *681 - *19 - *17 responses: @@ -101975,8 +102064,8 @@ paths: type: array items: *237 examples: - default: *681 - '400': *682 + default: *682 + '400': *683 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102005,7 +102094,7 @@ paths: application/json: schema: *237 examples: - default: &698 + default: &699 value: id: 40201 name: octo-name @@ -102367,9 +102456,9 @@ paths: application/json: schema: type: array - items: *671 + items: *672 examples: - default: *683 + default: *684 headers: Link: *54 '304': *37 @@ -102482,7 +102571,7 @@ paths: type: array items: *66 examples: - default: &690 + default: &691 summary: Default response value: - id: 1296269 @@ -102828,7 +102917,7 @@ paths: type: array items: *522 examples: - default: *684 + default: *685 headers: Link: *54 '304': *37 @@ -102907,7 +102996,7 @@ paths: application/json: schema: type: array - items: &685 + items: &686 title: Social account description: Social media account type: object @@ -102922,7 +103011,7 @@ paths: - provider - url examples: - default: &686 + default: &687 value: - provider: twitter url: https://twitter.com/github @@ -102984,9 +103073,9 @@ paths: application/json: schema: type: array - items: *685 + items: *686 examples: - default: *686 + default: *687 '422': *15 '304': *37 '404': *6 @@ -103073,7 +103162,7 @@ paths: application/json: schema: type: array - items: &687 + items: &688 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103093,7 +103182,7 @@ paths: - title - created_at examples: - default: &706 + default: &707 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103157,9 +103246,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *688 examples: - default: &688 + default: &689 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103189,7 +103278,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: - - &689 + - &690 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103201,9 +103290,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *688 examples: - default: *688 + default: *689 '404': *6 '304': *37 '403': *29 @@ -103226,7 +103315,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: - - *689 + - *690 responses: '204': description: Response @@ -103255,7 +103344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &707 + - &708 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 @@ -103280,11 +103369,11 @@ paths: type: array items: *66 examples: - default-response: *690 + default-response: *691 application/vnd.github.v3.star+json: schema: type: array - items: &708 + items: &709 title: Starred Repository description: Starred Repository type: object @@ -103653,10 +103742,10 @@ paths: application/json: schema: oneOf: + - *665 - *664 - - *663 examples: - default-response: &692 + default-response: &693 summary: Default response value: login: octocat @@ -103691,7 +103780,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &693 + response-with-git-hub-plan-information: &694 summary: Response with GitHub plan information value: login: octocat @@ -103813,7 +103902,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *691 + - *692 - *17 responses: '200': @@ -103862,11 +103951,11 @@ paths: application/json: schema: oneOf: + - *665 - *664 - - *663 examples: - default-response: *692 - response-with-git-hub-plan-information: *693 + default-response: *693 + response-with-git-hub-plan-information: *694 '404': *6 x-github: githubCloudOnly: false @@ -103916,8 +104005,8 @@ paths: required: - subject_digests examples: - default: *694 - withPredicateType: *695 + default: *695 + withPredicateType: *696 responses: '200': description: Response @@ -103970,7 +104059,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *696 + default: *697 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104216,7 +104305,7 @@ paths: type: array items: *237 examples: - default: *681 + default: *682 '403': *29 '401': *25 x-github: @@ -104600,9 +104689,9 @@ paths: application/json: schema: type: array - items: *672 + items: *673 examples: - default: *697 + default: *698 headers: Link: *54 x-github: @@ -104830,7 +104919,7 @@ paths: - docker - nuget - container - - *680 + - *681 - *59 - *19 - *17 @@ -104843,10 +104932,10 @@ paths: type: array items: *237 examples: - default: *681 + default: *682 '403': *29 '401': *25 - '400': *682 + '400': *683 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104876,7 +104965,7 @@ paths: application/json: schema: *237 examples: - default: *698 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105225,7 +105314,7 @@ paths: type: array items: *259 examples: - default: *699 + default: *700 headers: Link: *54 '304': *37 @@ -105236,6 +105325,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: + - *59 + - *255 + 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: *259 + 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': *37 + '403': *29 + '401': *25 + '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 @@ -105248,7 +105588,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *255 - - *700 + - *701 - *59 responses: '200': @@ -105257,7 +105597,7 @@ paths: application/json: schema: *259 examples: - default: *701 + default: *702 headers: Link: *54 '304': *37 @@ -105788,7 +106128,7 @@ paths: - *106 - *108 - *107 - - *702 + - *703 - *109 responses: '200': @@ -105919,7 +106259,7 @@ paths: parameters: - *59 - *106 - - *703 + - *704 - *107 responses: '200': @@ -106018,9 +106358,9 @@ paths: - *106 - *108 - *107 - - *704 - - *109 - *705 + - *109 + - *706 responses: '200': description: Response when getting a billing usage summary @@ -106154,9 +106494,9 @@ paths: application/json: schema: type: array - items: *685 + items: *686 examples: - default: *686 + default: *687 headers: Link: *54 x-github: @@ -106186,9 +106526,9 @@ paths: application/json: schema: type: array - items: *687 + items: *688 examples: - default: *706 + default: *707 headers: Link: *54 x-github: @@ -106213,7 +106553,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *59 - - *707 + - *708 - *48 - *17 - *19 @@ -106225,11 +106565,11 @@ paths: schema: anyOf: - type: array - items: *708 + items: *709 - type: array items: *66 examples: - default-response: *690 + default-response: *691 headers: Link: *54 x-github: @@ -106388,7 +106728,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &709 + enterprise: &710 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106446,7 +106786,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &710 + installation: &711 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106465,7 +106805,7 @@ x-webhooks: required: - id - node_id - organization: &711 + organization: &712 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106525,13 +106865,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &712 + repository: &713 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &742 + properties: &743 id: description: Unique identifier of the repository example: 42 @@ -107214,7 +107554,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &743 + required: &744 - archive_url - assignees_url - blobs_url @@ -107365,10 +107705,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -107444,11 +107784,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: &713 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + rule: &714 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) @@ -107671,11 +108011,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + rule: *714 sender: *4 required: - action @@ -107858,11 +108198,11 @@ x-webhooks: - everyone required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + rule: *714 sender: *4 required: - action @@ -107946,7 +108286,7 @@ x-webhooks: type: string enum: - completed - check_run: &715 + check_run: &716 title: CheckRun description: A check performed on the code of a given code change type: object @@ -108037,7 +108377,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *714 + deployment: *715 details_url: example: https://example.com type: string @@ -108122,10 +108462,10 @@ x-webhooks: - output - app - pull_requests - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 sender: *4 required: - check_run @@ -108518,11 +108858,11 @@ x-webhooks: type: string enum: - created - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *716 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 sender: *4 required: - check_run @@ -108918,11 +109258,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *716 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 requested_action: description: The action requested by the user. type: object @@ -109327,11 +109667,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *716 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 sender: *4 required: - check_run @@ -110308,10 +110648,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -110584,6 +110924,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -110996,10 +111341,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -111267,6 +111612,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -111678,10 +112028,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -111992,20 +112342,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &716 + commit_oid: &717 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: *709 - installation: *710 - organization: *711 - ref: &717 + enterprise: *710 + installation: *711 + organization: *712 + ref: &718 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: *712 + repository: *713 sender: *4 required: - action @@ -112400,12 +112750,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -112671,12 +113021,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -113008,12 +113358,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -113281,16 +113631,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 ref: 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 nullable: true - repository: *712 + repository: *713 sender: *4 required: - action @@ -113527,12 +113877,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -113789,10 +114139,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -113872,18 +114222,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *711 - pusher_type: &718 + organization: *712 + pusher_type: &719 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &719 + ref: &720 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113893,7 +114243,7 @@ x-webhooks: enum: - tag - branch - repository: *712 + repository: *713 sender: *4 required: - ref @@ -113976,9 +114326,9 @@ x-webhooks: enum: - created definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114063,9 +114413,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114143,9 +114493,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114223,9 +114573,9 @@ x-webhooks: enum: - updated definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114302,10 +114652,10 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - repository: *712 - organization: *711 + enterprise: *710 + installation: *711 + repository: *713 + organization: *712 sender: *4 new_property_values: type: array @@ -114390,18 +114740,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - pusher_type: *718 - ref: *719 + enterprise: *710 + installation: *711 + organization: *712 + pusher_type: *719 + ref: *720 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *712 + repository: *713 sender: *4 required: - ref @@ -114486,10 +114836,10 @@ x-webhooks: enum: - auto_dismissed alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114574,10 +114924,10 @@ x-webhooks: enum: - auto_reopened alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114662,10 +115012,10 @@ x-webhooks: enum: - created alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114748,10 +115098,10 @@ x-webhooks: enum: - dismissed alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114834,10 +115184,10 @@ x-webhooks: enum: - fixed alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114921,10 +115271,10 @@ x-webhooks: enum: - reintroduced alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -115007,10 +115357,10 @@ x-webhooks: enum: - reopened alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -115087,9 +115437,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - key: &720 + enterprise: *710 + installation: *711 + key: &721 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115125,8 +115475,8 @@ x-webhooks: - verified - created_at - read_only - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -115203,11 +115553,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - key: *720 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + key: *721 + organization: *712 + repository: *713 sender: *4 required: - action @@ -115768,12 +116118,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: &724 + workflow: &725 title: Workflow type: object nullable: true @@ -116503,9 +116853,9 @@ x-webhooks: pull_requests: type: array items: *571 - repository: *712 - organization: *711 - installation: *710 + repository: *713 + organization: *712 + installation: *711 sender: *4 responses: '200': @@ -116576,7 +116926,7 @@ x-webhooks: type: string enum: - approved - approver: &721 + approver: &722 type: object properties: avatar_url: @@ -116619,11 +116969,11 @@ x-webhooks: type: string comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: &722 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + reviewers: &723 type: array items: type: object @@ -116702,7 +117052,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &723 + workflow_job_run: &724 type: object properties: conclusion: @@ -117433,18 +117783,18 @@ x-webhooks: type: string enum: - rejected - approver: *721 + approver: *722 comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: *722 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + reviewers: *723 sender: *4 since: type: string - workflow_job_run: *723 + workflow_job_run: *724 workflow_job_runs: type: array items: @@ -118148,13 +118498,13 @@ x-webhooks: type: string enum: - requested - enterprise: *709 + enterprise: *710 environment: type: string - installation: *710 - organization: *711 - repository: *712 - requestor: &729 + installation: *711 + organization: *712 + repository: *713 + requestor: &730 title: User type: object nullable: true @@ -120053,12 +120403,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Deployment Workflow Run type: object @@ -120738,7 +121088,7 @@ x-webhooks: type: string enum: - answered - answer: &727 + answer: &728 type: object properties: author_association: @@ -120895,7 +121245,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &725 + discussion: &726 title: Discussion description: A Discussion in a repository. type: object @@ -121203,10 +121553,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121333,11 +121683,11 @@ x-webhooks: - from required: - category - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121420,11 +121770,11 @@ x-webhooks: type: string enum: - closed - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121506,7 +121856,7 @@ x-webhooks: type: string enum: - created - comment: &726 + comment: &727 type: object properties: author_association: @@ -121663,11 +122013,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121750,12 +122100,12 @@ x-webhooks: type: string enum: - deleted - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *727 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121850,12 +122200,12 @@ x-webhooks: - from required: - body - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *727 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121939,11 +122289,11 @@ x-webhooks: type: string enum: - created - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122025,11 +122375,11 @@ x-webhooks: type: string enum: - deleted - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122129,11 +122479,11 @@ x-webhooks: type: string required: - from - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122215,10 +122565,10 @@ x-webhooks: type: string enum: - labeled - discussion: *725 - enterprise: *709 - installation: *710 - label: &728 + discussion: *726 + enterprise: *710 + installation: *711 + label: &729 title: Label type: object properties: @@ -122250,8 +122600,8 @@ x-webhooks: - color - default - description - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122334,11 +122684,11 @@ x-webhooks: type: string enum: - locked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122420,11 +122770,11 @@ x-webhooks: type: string enum: - pinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122506,11 +122856,11 @@ x-webhooks: type: string enum: - reopened - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122595,16 +122945,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *725 - new_repository: *712 + new_discussion: *726 + new_repository: *713 required: - new_discussion - new_repository - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122687,10 +123037,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *725 - old_answer: *727 - organization: *711 - repository: *712 + discussion: *726 + old_answer: *728 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122772,12 +123122,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *725 - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122860,11 +123210,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122946,11 +123296,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -123023,7 +123373,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *709 + enterprise: *710 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123683,9 +124033,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - forkee @@ -123831,9 +124181,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pages: description: The pages that were updated. type: array @@ -123870,7 +124220,7 @@ x-webhooks: - action - sha - html_url - repository: *712 + repository: *713 sender: *4 required: - pages @@ -123946,10 +124296,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: &730 + organization: *712 + repositories: &731 description: An array of repository objects that the installation can access. type: array @@ -123975,8 +124325,8 @@ x-webhooks: - name - full_name - private - repository: *712 - requester: *729 + repository: *713 + requester: *730 sender: *4 required: - action @@ -124051,11 +124401,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124131,11 +124481,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124211,10 +124561,10 @@ x-webhooks: type: string enum: - added - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories_added: &731 + organization: *712 + repositories_added: &732 description: An array of repository objects, which were added to the installation. type: array @@ -124260,15 +124610,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *712 - repository_selection: &732 + repository: *713 + repository_selection: &733 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *729 + requester: *730 sender: *4 required: - action @@ -124347,10 +124697,10 @@ x-webhooks: type: string enum: - removed - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories_added: *731 + organization: *712 + repositories_added: *732 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124377,9 +124727,9 @@ x-webhooks: - name - full_name - private - repository: *712 - repository_selection: *732 - requester: *729 + repository: *713 + repository_selection: *733 + requester: *730 sender: *4 required: - action @@ -124458,11 +124808,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124640,10 +124990,10 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 target_type: type: string @@ -124722,11 +125072,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124978,8 +125328,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125773,8 +126123,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126123,8 +126473,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -126204,7 +126554,7 @@ x-webhooks: type: string enum: - deleted - comment: &733 + comment: &734 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126369,8 +126719,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127160,8 +127510,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127512,8 +127862,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -127593,7 +127943,7 @@ x-webhooks: type: string enum: - edited - changes: &762 + changes: &763 description: The changes to the comment. type: object properties: @@ -127605,9 +127955,9 @@ x-webhooks: type: string required: - from - comment: *733 - enterprise: *709 - installation: *710 + comment: *734 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128400,8 +128750,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128750,8 +129100,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -128841,9 +129191,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -128937,9 +129287,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -129032,9 +129382,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -129128,9 +129478,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -129215,10 +129565,10 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - issue: &736 + assignee: *730 + enterprise: *710 + installation: *711 + issue: &737 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130007,11 +130357,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130128,8 +130478,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -130209,8 +130559,8 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -131004,11 +131354,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131260,8 +131610,8 @@ x-webhooks: required: - state - closed_at - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -131340,8 +131690,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,11 +132476,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132246,8 +132596,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -132326,8 +132676,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133134,11 +133484,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133233,7 +133583,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &734 + milestone: &735 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133371,8 +133721,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -133471,8 +133821,8 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134261,11 +134611,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134382,9 +134732,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -134464,8 +134814,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135253,11 +135603,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135374,9 +135724,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -135456,8 +135806,8 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136269,11 +136619,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136367,8 +136717,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -136447,8 +136797,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137254,11 +137604,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137352,9 +137702,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *734 - organization: *711 - repository: *712 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -138222,11 +138572,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138788,8 +139138,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139578,11 +139928,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139698,8 +140048,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -139779,9 +140129,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *709 - installation: *710 - issue: &735 + enterprise: *710 + installation: *711 + issue: &736 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140564,11 +140914,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140684,8 +141034,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -140764,8 +141114,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141575,11 +141925,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141674,8 +142024,8 @@ x-webhooks: user_view_type: type: string type: *219 - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -142541,11 +142891,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143129,11 +143479,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *736 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143213,12 +143563,12 @@ x-webhooks: type: string enum: - typed - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *710 + installation: *711 + issue: *737 type: *219 - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143299,7 +143649,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &766 title: User type: object nullable: true @@ -143369,11 +143719,11 @@ x-webhooks: required: - login - id - enterprise: *709 - installation: *710 - issue: *736 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *737 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143452,12 +143802,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - issue: *736 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *737 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143537,8 +143887,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144348,11 +144698,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144446,8 +144796,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144527,11 +144877,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *736 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144610,12 +144960,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *710 + installation: *711 + issue: *737 type: *219 - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144695,11 +145045,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144777,11 +145127,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144891,11 +145241,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144977,9 +145327,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: &737 + enterprise: *710 + installation: *711 + marketplace_purchase: &738 title: Marketplace Purchase type: object required: @@ -145062,8 +145412,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: &738 + organization: *712 + previous_marketplace_purchase: &739 title: Marketplace Purchase type: object properties: @@ -145143,7 +145493,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *713 sender: *4 required: - action @@ -145223,10 +145573,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *710 + installation: *711 + marketplace_purchase: *738 + organization: *712 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145309,7 +145659,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *713 sender: *4 required: - action @@ -145391,10 +145741,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *710 + installation: *711 + marketplace_purchase: *738 + organization: *712 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145476,7 +145826,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *713 sender: *4 required: - action @@ -145557,8 +145907,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 marketplace_purchase: title: Marketplace Purchase type: object @@ -145640,9 +145990,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + organization: *712 + previous_marketplace_purchase: *739 + repository: *713 sender: *4 required: - action @@ -145722,12 +146072,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + enterprise: *710 + installation: *711 + marketplace_purchase: *738 + organization: *712 + previous_marketplace_purchase: *739 + repository: *713 sender: *4 required: - action @@ -145829,11 +146179,11 @@ x-webhooks: type: string required: - to - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 sender: *4 required: - action @@ -145933,11 +146283,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146016,11 +146366,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146098,11 +146448,11 @@ x-webhooks: type: string enum: - added - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146178,7 +146528,7 @@ x-webhooks: required: - login - id - team: &739 + team: &740 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146401,11 +146751,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146482,7 +146832,7 @@ x-webhooks: required: - login - id - team: *739 + team: *740 required: - action - scope @@ -146564,8 +146914,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *710 - merge_group: &741 + installation: *711 + merge_group: &742 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146584,15 +146934,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *740 + head_commit: *741 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146678,10 +147028,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *710 - merge_group: *741 - organization: *711 - repository: *712 + installation: *711 + merge_group: *742 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146754,7 +147104,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *710 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146863,16 +147213,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *710 - organization: *711 + installation: *711 + organization: *712 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -146953,11 +147303,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147036,9 +147386,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - milestone: &744 + enterprise: *710 + installation: *711 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147175,8 +147525,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147255,11 +147605,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147369,11 +147719,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147453,11 +147803,11 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - milestone: *744 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *745 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147536,11 +147886,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *730 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147619,11 +147969,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *730 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147702,9 +148052,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - membership: &745 + enterprise: *710 + installation: *711 + membership: &746 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147811,8 +148161,8 @@ x-webhooks: - role - organization_url - user - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147890,11 +148240,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + membership: *746 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147973,8 +148323,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148090,10 +148440,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 - user: *729 + user: *730 required: - action - invitation @@ -148171,11 +148521,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + membership: *746 + organization: *712 + repository: *713 sender: *4 required: - action @@ -148262,11 +148612,11 @@ x-webhooks: properties: from: type: string - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + membership: *746 + organization: *712 + repository: *713 sender: *4 required: - action @@ -148342,9 +148692,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 package: description: Information about the package. type: object @@ -148843,7 +149193,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &746 + items: &747 title: Ruby Gems metadata type: object properties: @@ -148938,7 +149288,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -149014,9 +149364,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 package: description: Information about the package. type: object @@ -149369,7 +149719,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *747 source_url: type: string format: uri @@ -149439,7 +149789,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -149616,12 +149966,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *709 + enterprise: *710 id: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - id @@ -149698,7 +150048,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &747 + personal_access_token_request: &748 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149844,10 +150194,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *709 - organization: *711 + enterprise: *710 + organization: *712 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -149924,11 +150274,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *748 + enterprise: *710 + organization: *712 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -150004,11 +150354,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *748 + enterprise: *710 + organization: *712 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -150083,11 +150433,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *747 - organization: *711 - enterprise: *709 + personal_access_token_request: *748 + organization: *712 + enterprise: *710 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -150192,7 +150542,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *748 + last_response: *749 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150224,8 +150574,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 zen: description: Random string of GitHub zen. @@ -150470,10 +150820,10 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: &749 + enterprise: *710 + installation: *711 + organization: *712 + project_card: &750 title: Project Card type: object properties: @@ -150592,7 +150942,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *713 sender: *4 required: - action @@ -150673,11 +151023,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_card: *750 + repository: *713 sender: *4 required: - action @@ -150757,9 +151107,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 project_card: title: Project Card type: object @@ -150887,8 +151237,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -150982,11 +151332,11 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_card: *750 + repository: *713 sender: *4 required: - action @@ -151080,9 +151430,9 @@ x-webhooks: - from required: - column_id - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 project_card: allOf: - title: Project Card @@ -151272,7 +151622,7 @@ x-webhooks: type: string required: - after_id - repository: *712 + repository: *713 sender: *4 required: - action @@ -151352,10 +151702,10 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - organization: *711 - project: &751 + enterprise: *710 + installation: *711 + organization: *712 + project: &752 title: Project type: object properties: @@ -151479,7 +151829,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *713 sender: *4 required: - action @@ -151559,10 +151909,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_column: &750 + enterprise: *710 + installation: *711 + organization: *712 + project_column: &751 title: Project Column type: object properties: @@ -151601,7 +151951,7 @@ x-webhooks: - name - created_at - updated_at - repository: *712 + repository: *713 sender: *4 required: - action @@ -151680,18 +152030,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 + enterprise: *710 + installation: *711 + organization: *712 + project_column: *751 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -151781,11 +152131,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_column: *751 + repository: *713 sender: *4 required: - action @@ -151865,11 +152215,11 @@ x-webhooks: type: string enum: - moved - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_column: *751 + repository: *713 sender: *4 required: - action @@ -151949,11 +152299,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 + repository: *713 sender: *4 required: - action @@ -152033,18 +152383,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project: *751 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -152146,11 +152496,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 + repository: *713 sender: *4 required: - action @@ -152229,11 +152579,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 + repository: *713 sender: *4 required: - action @@ -152314,8 +152664,8 @@ x-webhooks: type: string enum: - closed - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152397,8 +152747,8 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152480,8 +152830,8 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152599,8 +152949,8 @@ x-webhooks: type: string to: type: string - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152684,7 +153034,7 @@ x-webhooks: type: string enum: - archived - changes: &755 + changes: &756 type: object properties: archived_at: @@ -152698,9 +153048,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *710 - organization: *711 - projects_v2_item: &752 + installation: *711 + organization: *712 + projects_v2_item: &753 title: Projects v2 Item description: An item belonging to a project type: object @@ -152835,9 +153185,9 @@ x-webhooks: nullable: true to: type: string - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -152919,9 +153269,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153002,9 +153352,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153110,7 +153460,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &753 + - &754 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153132,7 +153482,7 @@ x-webhooks: required: - id - name - - &754 + - &755 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153166,8 +153516,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *753 - *754 + - *755 required: - field_value - type: object @@ -153183,9 +153533,9 @@ x-webhooks: nullable: true required: - body - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153280,9 +153630,9 @@ x-webhooks: to: type: string nullable: true - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153365,10 +153715,10 @@ x-webhooks: type: string enum: - restored - changes: *755 - installation: *710 - organization: *711 - projects_v2_item: *752 + changes: *756 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153450,8 +153800,8 @@ x-webhooks: type: string enum: - reopened - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -153533,14 +153883,14 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_status_update: &758 + installation: *711 + organization: *712 + projects_v2_status_update: &759 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *756 - required: *757 + properties: *757 + required: *758 sender: *4 required: - action @@ -153621,9 +153971,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *711 + organization: *712 + projects_v2_status_update: *759 sender: *4 required: - action @@ -153759,9 +154109,9 @@ x-webhooks: type: string format: date nullable: true - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *711 + organization: *712 + projects_v2_status_update: *759 sender: *4 required: - action @@ -153832,10 +154182,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - repository @@ -153912,13 +154262,13 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - number: &759 + assignee: *730 + enterprise: *710 + installation: *711 + number: &760 description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -156201,7 +156551,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -156283,11 +156633,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -158565,7 +158915,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *713 sender: *4 required: - action @@ -158647,11 +158997,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -160929,7 +161279,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *713 sender: *4 required: - action @@ -161011,11 +161361,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: &760 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: &761 allOf: - *571 - type: object @@ -161079,7 +161429,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *712 + repository: *713 sender: *4 required: - action @@ -161160,12 +161510,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -161245,11 +161595,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 + enterprise: *710 milestone: *553 - number: *759 - organization: *711 - pull_request: &761 + number: *760 + organization: *712 + pull_request: &762 title: Pull Request type: object properties: @@ -163512,7 +163862,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -163591,11 +163941,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -165877,7 +166227,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *712 + repository: *713 sender: *4 required: - action @@ -166001,12 +166351,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -166086,11 +166436,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -168357,7 +168707,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -168437,11 +168787,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + label: *729 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -170723,7 +171073,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -170804,10 +171154,10 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -173087,7 +173437,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -173167,12 +173517,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 + enterprise: *710 milestone: *553 - number: *759 - organization: *711 - pull_request: *761 - repository: *712 + number: *760 + organization: *712 + pull_request: *762 + repository: *713 sender: *4 required: - action @@ -173251,12 +173601,12 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -173337,12 +173687,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -173422,12 +173772,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -173793,9 +174143,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: type: object properties: @@ -175965,7 +176315,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *713 sender: *4 required: - action @@ -176045,7 +176395,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &764 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176330,9 +176680,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: type: object properties: @@ -178490,7 +178840,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *713 sender: *4 required: - action @@ -178570,11 +178920,11 @@ x-webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *709 - installation: *710 - organization: *711 + changes: *763 + comment: *764 + enterprise: *710 + installation: *711 + organization: *712 pull_request: type: object properties: @@ -180735,7 +181085,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *713 sender: *4 required: - action @@ -180816,9 +181166,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -182991,7 +183341,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *713 review: description: The review that was affected. type: object @@ -183238,9 +183588,9 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -185294,8 +185644,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: &764 + repository: *713 + review: &765 description: The review that was affected. type: object properties: @@ -185528,12 +185878,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -187816,7 +188166,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_reviewer: title: User type: object @@ -187900,12 +188250,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -190195,7 +190545,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190387,12 +190737,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -192677,7 +193027,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_reviewer: title: User type: object @@ -192762,12 +193112,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -195043,7 +195393,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195224,9 +195574,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -197401,8 +197751,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: *764 + repository: *713 + review: *765 sender: *4 required: - action @@ -197482,9 +197832,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -199554,7 +199904,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *713 sender: *4 thread: type: object @@ -199941,9 +200291,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -201999,7 +202349,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *713 sender: *4 thread: type: object @@ -202389,10 +202739,10 @@ x-webhooks: type: string before: type: string - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -204663,7 +205013,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -204745,11 +205095,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + assignee: *766 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -207032,7 +207382,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -207111,11 +207461,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + label: *729 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -209388,7 +209738,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -209469,10 +209819,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -211737,7 +212087,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -211937,7 +212287,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *709 + enterprise: *710 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212029,8 +212379,8 @@ x-webhooks: - url - author - committer - installation: *710 - organization: *711 + installation: *711 + organization: *712 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212605,9 +212955,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 registry_package: type: object properties: @@ -213053,7 +213403,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *746 + items: *747 summary: type: string tag_name: @@ -213107,7 +213457,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -213185,9 +213535,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 registry_package: type: object properties: @@ -213495,7 +213845,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *747 summary: type: string tag_name: @@ -213544,7 +213894,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -213621,10 +213971,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - release: &766 + enterprise: *710 + installation: *711 + organization: *712 + release: &767 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213942,7 +214292,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *712 + repository: *713 sender: *4 required: - action @@ -214019,11 +214369,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *767 + repository: *713 sender: *4 required: - action @@ -214140,11 +214490,11 @@ x-webhooks: type: boolean required: - to - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *767 + repository: *713 sender: *4 required: - action @@ -214222,9 +214572,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214546,7 +214896,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *713 sender: *4 required: - action @@ -214622,10 +214972,10 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - release: &767 + enterprise: *710 + installation: *711 + organization: *712 + release: &768 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214944,7 +215294,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *713 sender: *4 required: - action @@ -215020,11 +215370,11 @@ x-webhooks: type: string enum: - released - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *767 + repository: *713 sender: *4 required: - action @@ -215100,11 +215450,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *709 - installation: *710 - organization: *711 - release: *767 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *768 + repository: *713 sender: *4 required: - action @@ -215180,11 +215530,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + repository_advisory: *636 sender: *4 required: - action @@ -215260,11 +215610,11 @@ x-webhooks: type: string enum: - reported - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + repository_advisory: *636 sender: *4 required: - action @@ -215340,10 +215690,10 @@ x-webhooks: type: string enum: - archived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215420,10 +215770,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215501,10 +215851,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215588,10 +215938,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215703,10 +216053,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215778,10 +216128,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 status: type: string @@ -215862,10 +216212,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215942,10 +216292,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216039,10 +216389,10 @@ x-webhooks: - name required: - repository - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216122,10 +216472,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 repository_ruleset: *298 sender: *4 required: @@ -216204,10 +216554,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 repository_ruleset: *298 sender: *4 required: @@ -216286,10 +216636,10 @@ x-webhooks: type: string enum: - edited - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 repository_ruleset: *298 changes: type: object @@ -216594,10 +216944,10 @@ x-webhooks: - from required: - owner - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216675,10 +217025,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216756,7 +217106,7 @@ x-webhooks: type: string enum: - create - alert: &768 + alert: &769 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216877,10 +217227,10 @@ x-webhooks: type: string enum: - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217086,10 +217436,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217167,11 +217517,11 @@ x-webhooks: type: string enum: - reopen - alert: *768 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *769 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217370,10 +217720,10 @@ x-webhooks: enum: - fixed - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217391,7 +217741,7 @@ x-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. @@ -217399,8 +217749,8 @@ x-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: @@ -217444,14 +217794,14 @@ x-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: &769 + - assigned + alert: &770 type: object properties: number: *161 @@ -217569,10 +217919,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + assignee: *4 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + 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: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217653,11 +218086,11 @@ x-webhooks: type: string enum: - created - alert: *769 - installation: *710 - location: *770 - organization: *711 - repository: *712 + alert: *770 + installation: *711 + location: *771 + organization: *712 + repository: *713 sender: *4 required: - location @@ -217895,11 +218328,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217977,11 +218410,11 @@ x-webhooks: type: string enum: - reopened - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -218059,11 +218492,94 @@ x-webhooks: type: string enum: - resolved - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + 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: *770 + assignee: *4 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -218141,11 +218657,11 @@ x-webhooks: type: string enum: - validated - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -218271,10 +218787,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *712 - enterprise: *709 - installation: *710 - organization: *711 + repository: *713 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -218352,11 +218868,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: &771 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + security_advisory: &772 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218539,11 +219055,11 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: *771 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + security_advisory: *772 sender: *4 required: - action @@ -218616,10 +219132,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218804,9 +219320,9 @@ x-webhooks: type: object properties: security_and_analysis: *272 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: *333 sender: *4 required: @@ -218885,12 +219401,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: &772 + sponsorship: &773 type: object properties: created_at: @@ -219191,12 +219707,12 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - sponsorship @@ -219284,12 +219800,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - changes @@ -219366,17 +219882,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &774 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: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - sponsorship @@ -219450,7 +219966,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &775 type: object properties: tier: @@ -219494,13 +220010,13 @@ x-webhooks: - from required: - tier - effective_date: *773 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + effective_date: *774 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - changes @@ -219577,13 +220093,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + changes: *775 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - changes @@ -219657,10 +220173,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219743,10 +220259,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220166,15 +220682,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *709 + enterprise: *710 id: description: The unique identifier of the status. type: integer - installation: *710 + installation: *711 name: type: string - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 sha: description: The Commit SHA. @@ -220289,9 +220805,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220381,9 +220897,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220473,9 +220989,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220565,9 +221081,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220644,12 +221160,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - team: &775 + team: &776 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220872,9 +221388,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -221332,7 +221848,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -221408,9 +221924,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -221868,7 +222384,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -221945,9 +222461,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -222405,7 +222921,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -222549,9 +223065,9 @@ x-webhooks: - from required: - permissions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -223009,7 +223525,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - changes @@ -223087,9 +223603,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -223547,7 +224063,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -223623,10 +224139,10 @@ x-webhooks: type: string enum: - started - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -223699,16 +224215,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *709 + enterprise: *710 inputs: type: object nullable: true additionalProperties: true - installation: *710 - organization: *711 + installation: *711 + organization: *712 ref: type: string - repository: *712 + repository: *713 sender: *4 workflow: type: string @@ -223790,10 +224306,10 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: allOf: @@ -224109,10 +224625,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: allOf: @@ -224451,10 +224967,10 @@ x-webhooks: type: string enum: - queued - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: type: object @@ -224668,10 +225184,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: type: object @@ -224887,12 +225403,12 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -225891,12 +226407,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -226880,12 +227396,12 @@ x-webhooks: type: string enum: - requested - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 5a35ecf80..48d2c605f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -4718,6 +4718,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.", @@ -5703,6 +5711,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.", @@ -6542,6 +6558,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.", @@ -7012,6 +7036,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.", @@ -9037,6 +9069,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.", @@ -10073,6 +10113,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.", @@ -11026,6 +11074,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.", @@ -11690,6 +11746,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.", @@ -54329,7 +54393,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" + ] + } + } } } } @@ -102968,6 +103047,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.", @@ -103968,6 +104055,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.", @@ -139240,21 +139335,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", @@ -168149,6 +168262,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.", @@ -224334,6 +224470,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224354,6 +224491,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242552,6 +242690,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242572,6 +242711,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278220,6 +278360,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278240,6 +278381,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283974,6 +284116,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283994,6 +284137,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289303,6 +289447,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289323,6 +289468,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289849,6 +289995,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289869,6 +290016,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290419,6 +290567,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290439,6 +290588,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -324211,6 +324361,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.", @@ -406452,6 +406610,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -406472,6 +406631,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437285,6 +437445,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437305,6 +437466,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -468363,6 +468525,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.", @@ -470603,7 +470788,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" @@ -470673,6 +470858,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -470680,6 +470870,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -470689,6 +470884,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -471665,7 +471872,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 + } } } } @@ -471679,7 +471906,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", @@ -498900,6 +499127,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -499112,6 +499340,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -540360,6 +540589,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.", @@ -589101,6 +589338,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.", @@ -595498,51 +595743,720 @@ "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { @@ -595743,21 +596657,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", @@ -647113,6 +648045,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -649494,6 +650433,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -757124,6 +758070,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.", @@ -759716,6 +760670,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.", @@ -762215,6 +763177,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.", @@ -764714,6 +765684,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.", @@ -767345,6 +768323,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.", @@ -769983,6 +770969,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.", @@ -774244,6 +775238,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.", @@ -1169291,200 +1170293,3589 @@ "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1170992,7 +1175383,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1171008,23 +1175399,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": [ { @@ -1171089,15 +1175478,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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).\"", @@ -1172604,6 +1177169,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1172619,21 +1177185,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" }, @@ -1172700,13 +1177264,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": { @@ -1174405,11 +1178969,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" }, @@ -1174476,13 +1179040,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": { @@ -1174493,9 +1179057,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1174515,10 +1179076,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1174614,9 +1179171,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1174656,7 +1179210,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1176163,279 +1180718,855 @@ "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": { + "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, + "nullable": 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", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1177944,8 +1183075,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1177959,21 +1183089,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": [ { @@ -1178038,179 +1183169,630 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1179721,8 +1185303,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1179736,21 +1185317,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": [ { @@ -1179815,7 +1185397,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1180442,74 +1186024,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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1180531,6 +1186045,314 @@ "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.", + "example": "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", + "example": "/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", + "example": "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", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", @@ -1181947,10 +1187769,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" + } + } } } } @@ -1181962,8 +1187959,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1181972,13 +1187970,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": [ { @@ -1182043,13 +1188041,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": { @@ -1182670,6 +1188668,74 @@ } } }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1182691,314 +1188757,6 @@ "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.", - "example": "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", - "example": "/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", - "example": "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", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", @@ -1184415,185 +1190173,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" - } - } } } } @@ -1184605,9 +1190188,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1184616,11 +1190198,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" }, @@ -1184687,13 +1190269,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": { @@ -1186844,11 +1192426,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" }, @@ -1186915,13 +1192497,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": { @@ -1189072,11 +1194654,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" }, @@ -1189143,13 +1194725,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": { @@ -1189770,6 +1195352,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index e26d2a991..3778c635d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1023,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &638 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -2208,6 +2208,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 @@ -10675,7 +10682,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &649 + sub_issues_summary: &650 title: Sub-issues Summary type: object properties: @@ -10695,7 +10702,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &650 + issue_dependencies_summary: &651 title: Issue Dependencies Summary type: object properties: @@ -10714,7 +10721,7 @@ paths: - total_blocking issue_field_values: type: array - items: &651 + items: &652 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11365,7 +11372,7 @@ paths: url: type: string format: uri - user: &663 + user: &664 title: Public User description: Public User type: object @@ -16585,7 +16592,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': *25 '403': *29 @@ -16716,7 +16735,7 @@ paths: required: false schema: type: string - - &702 + - &703 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -16862,7 +16881,7 @@ paths: parameters: - *63 - *106 - - &703 + - &704 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 @@ -16974,7 +16993,7 @@ paths: - *106 - *108 - *107 - - &704 + - &705 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -16982,7 +17001,7 @@ paths: schema: type: string - *109 - - &705 + - &706 name: sku description: The SKU to query for usage. in: query @@ -20546,7 +20565,7 @@ paths: type: array items: *143 examples: - default: &666 + default: &667 value: total_count: 1 repositories: @@ -23442,12 +23461,12 @@ paths: required: - subject_digests examples: - default: &694 + default: &695 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &695 + withPredicateType: &696 value: subject_digests: - sha256:abc123 @@ -23505,7 +23524,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &696 + default: &697 value: attestations_subject_digests: - sha256:abc: @@ -33071,7 +33090,7 @@ paths: parameters: - *63 - *231 - - &679 + - &680 name: repo_name description: repo_name parameter in: path @@ -34110,7 +34129,7 @@ paths: - nuget - container - *63 - - &680 + - &681 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34151,7 +34170,7 @@ paths: default: *238 '403': *29 '401': *25 - '400': &682 + '400': &683 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35943,7 +35962,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &756 + properties: &757 id: type: number description: The unique identifier of the status update. @@ -35991,7 +36010,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &757 + required: &758 - id - node_id - created_at @@ -36809,7 +36828,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &700 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36941,7 +36960,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *255 - - &700 + - &701 name: field_id description: The unique identifier of the field. in: path @@ -36956,7 +36975,7 @@ paths: application/json: schema: *259 examples: - default: &701 + default: &702 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36965,17 +36984,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: @@ -41810,6 +41841,25 @@ paths: schema: type: string - &608 + 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 + - &609 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. @@ -41824,7 +41874,7 @@ paths: - *48 - *19 - *17 - - &609 + - &610 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 @@ -41834,7 +41884,7 @@ paths: required: false schema: type: string - - &610 + - &611 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 @@ -41844,7 +41894,7 @@ paths: required: false schema: type: string - - &611 + - &612 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41853,7 +41903,7 @@ paths: required: false schema: type: string - - &612 + - &613 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41862,7 +41912,7 @@ paths: schema: type: boolean default: false - - &613 + - &614 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41871,7 +41921,7 @@ paths: schema: type: boolean default: false - - &614 + - &615 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41906,14 +41956,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &616 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: &616 + resolution: &617 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -42020,8 +42070,8 @@ paths: pull request. ' - oneOf: &617 - - &619 + oneOf: &618 + - &620 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42073,7 +42123,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &621 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. @@ -42128,7 +42178,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &622 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42142,7 +42192,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &622 + - &623 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42156,7 +42206,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &623 + - &624 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42170,7 +42220,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &624 + - &625 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42184,7 +42234,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &626 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42198,7 +42248,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &627 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42212,7 +42262,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &628 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. @@ -42226,7 +42276,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &628 + - &629 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. @@ -42240,7 +42290,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &629 + - &630 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. @@ -42254,7 +42304,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &630 + - &631 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. @@ -42268,7 +42318,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &631 + - &632 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. @@ -42766,7 +42816,7 @@ paths: application/json: schema: type: array - items: &635 + items: &636 description: A repository security advisory. type: object properties: @@ -43057,7 +43107,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &637 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44968,7 +45018,7 @@ paths: - updated_at - url examples: - default: &653 + default: &654 value: - author: login: octocat @@ -45216,7 +45266,7 @@ paths: application/json: schema: *314 examples: - default: &654 + default: &655 value: author: login: octocat @@ -45399,7 +45449,7 @@ paths: - updated_at - url examples: - default: &655 + default: &656 value: - author: login: octocat @@ -45625,7 +45675,7 @@ paths: application/json: schema: *317 examples: - default: &656 + default: &657 value: author: login: octocat @@ -46241,7 +46291,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &657 + response-if-user-is-a-team-maintainer: &658 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46306,7 +46356,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: &658 + response-if-users-membership-with-team-is-now-pending: &659 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46447,7 +46497,7 @@ paths: - updated_at - permissions examples: - default: &659 + default: &660 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46526,7 +46576,7 @@ paths: application/json: schema: *325 examples: - default: &660 + default: &661 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46736,7 +46786,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &661 + schema: &662 title: Team Repository description: A team's access to a repository. type: object @@ -47393,7 +47443,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: &662 + response-if-child-teams-exist: &663 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -55356,6 +55406,7 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: @@ -58569,7 +58620,7 @@ paths: check. type: array items: *406 - deployment: &714 + deployment: &715 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -59481,7 +59532,7 @@ paths: type: string format: date-time nullable: true - head_commit: &740 + head_commit: &741 title: Simple Commit description: A commit. type: object @@ -63714,14 +63765,14 @@ paths: type: integer machines: type: array - items: &669 + items: &670 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *448 required: *449 examples: - default: &670 + default: &671 value: total_count: 2 machines: @@ -66731,7 +66782,7 @@ paths: application/json: schema: type: array - items: &640 + items: &641 title: Status description: The status of a commit. type: object @@ -68287,7 +68338,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &633 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -74021,7 +74072,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &748 + last_response: &749 title: Hook Response type: object properties: @@ -75072,7 +75123,7 @@ paths: parameters: - *327 - *328 - - &691 + - &692 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75506,7 +75557,7 @@ paths: type: array items: *522 examples: - default: &684 + default: &685 value: - id: 1 repository: @@ -89281,15 +89332,16 @@ paths: - *606 - *607 - *608 + - *609 - *48 - *19 - *17 - - *609 - *610 - *611 - *612 - *613 - *614 + - *615 responses: '200': description: Response @@ -89297,7 +89349,7 @@ paths: application/json: schema: type: array - items: &618 + items: &619 type: object properties: number: *161 @@ -89316,8 +89368,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolved_at: type: string format: date-time @@ -89413,7 +89465,7 @@ paths: pull request. ' - oneOf: *617 + oneOf: *618 nullable: true has_more_locations: type: boolean @@ -89565,13 +89617,13 @@ paths: - *327 - *328 - *427 - - *614 + - *615 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -89613,6 +89665,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. @@ -89633,27 +89687,42 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *616 + resolution: *617 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *618 + schema: *619 examples: default: value: @@ -89698,6 +89767,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. @@ -89705,7 +89793,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': *104 x-github: enabledForGitHubApps: true @@ -89741,7 +89830,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &771 type: object properties: type: @@ -89767,7 +89856,6 @@ paths: example: commit details: oneOf: - - *619 - *620 - *621 - *622 @@ -89780,6 +89868,7 @@ paths: - *629 - *630 - *631 + - *632 examples: default: value: @@ -89874,14 +89963,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &634 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *633 required: - reason - placeholder_id @@ -89898,7 +89987,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *634 expire_at: type: string format: date-time @@ -89960,7 +90049,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &635 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89986,15 +90075,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *634 + items: *635 backfill_scans: type: array - items: *634 + items: *635 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *635 - type: object properties: pattern_name: @@ -90109,9 +90198,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *636 + default: *637 '400': *14 '404': *6 x-github: @@ -90295,9 +90384,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: &638 + default: &639 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90635,7 +90724,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -90784,15 +90873,15 @@ paths: parameters: - *327 - *328 - - *637 + - *638 responses: '200': description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 + default: *639 '403': *29 '404': *6 x-github: @@ -90818,7 +90907,7 @@ paths: parameters: - *327 - *328 - - *637 + - *638 requestBody: required: true content: @@ -90977,10 +91066,10 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: - default: *638 - add_credit: *638 + default: *639 + add_credit: *639 '403': *29 '404': *6 '422': @@ -91020,7 +91109,7 @@ paths: parameters: - *327 - *328 - - *637 + - *638 responses: '202': *39 '400': *14 @@ -91049,7 +91138,7 @@ paths: parameters: - *327 - *328 - - *637 + - *638 responses: '202': description: Response @@ -91193,7 +91282,7 @@ paths: application/json: schema: type: array - items: &639 + items: &640 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91566,7 +91655,7 @@ paths: application/json: schema: type: array - items: *639 + items: *640 examples: default: value: @@ -91654,7 +91743,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *641 examples: default: value: @@ -91748,7 +91837,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &642 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91843,7 +91932,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -91980,7 +92069,7 @@ paths: application/json: schema: type: array - items: &642 + items: &643 title: Tag protection description: Tag protection type: object @@ -92056,7 +92145,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *643 examples: default: value: @@ -92204,7 +92293,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &644 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92216,7 +92305,7 @@ paths: required: - names examples: - default: &644 + default: &645 value: names: - octocat @@ -92271,9 +92360,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 '404': *6 '422': *7 x-github: @@ -92296,7 +92385,7 @@ paths: parameters: - *327 - *328 - - &645 + - &646 name: per description: The time frame to display results for. in: query @@ -92325,7 +92414,7 @@ paths: example: 128 clones: type: array - items: &646 + items: &647 title: Traffic type: object properties: @@ -92566,7 +92655,7 @@ paths: parameters: - *327 - *328 - - *645 + - *646 responses: '200': description: Response @@ -92585,7 +92674,7 @@ paths: example: 3782 views: type: array - items: *646 + items: *647 required: - uniques - count @@ -93354,7 +93443,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &647 + text_matches: &648 title: Search Result Text Matches type: array items: @@ -93516,7 +93605,7 @@ paths: enum: - author-date - committer-date - - &648 + - &649 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 @@ -93644,7 +93733,7 @@ paths: type: number node_id: type: string - text_matches: *647 + text_matches: *648 required: - sha - node_id @@ -93836,7 +93925,7 @@ paths: - interactions - created - updated - - *648 + - *649 - *17 - *19 - name: advanced_search @@ -93933,11 +94022,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: type: string state_reason: @@ -93969,7 +94058,7 @@ paths: type: string format: date-time nullable: true - text_matches: *647 + text_matches: *648 pull_request: type: object properties: @@ -94194,7 +94283,7 @@ paths: enum: - created - updated - - *648 + - *649 - *17 - *19 responses: @@ -94238,7 +94327,7 @@ paths: nullable: true score: type: number - text_matches: *647 + text_matches: *648 required: - id - node_id @@ -94323,7 +94412,7 @@ paths: - forks - help-wanted-issues - updated - - *648 + - *649 - *17 - *19 responses: @@ -94562,7 +94651,7 @@ paths: - admin - pull - push - text_matches: *647 + text_matches: *648 temp_clone_token: type: string allow_merge_commit: @@ -94862,7 +94951,7 @@ paths: type: string format: uri nullable: true - text_matches: *647 + text_matches: *648 related: type: array nullable: true @@ -95053,7 +95142,7 @@ paths: - followers - repositories - joined - - *648 + - *649 - *17 - *19 responses: @@ -95157,7 +95246,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *647 + text_matches: *648 blog: type: string nullable: true @@ -95236,7 +95325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &652 + - &653 name: team_id description: The unique identifier of the team. in: path @@ -95277,7 +95366,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *652 + - *653 requestBody: required: true content: @@ -95377,7 +95466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *652 + - *653 responses: '204': description: Response @@ -95408,7 +95497,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *652 + - *653 - *48 - *17 - *19 @@ -95421,7 +95510,7 @@ paths: type: array items: *314 examples: - default: *653 + default: *654 headers: Link: *54 x-github: @@ -95450,7 +95539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *652 + - *653 requestBody: required: true content: @@ -95513,7 +95602,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *652 + - *653 - *316 responses: '200': @@ -95547,7 +95636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *652 + - *653 - *316 requestBody: required: false @@ -95573,7 +95662,7 @@ paths: application/json: schema: *314 examples: - default: *654 + default: *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95598,7 +95687,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *652 + - *653 - *316 responses: '204': @@ -95628,7 +95717,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *652 + - *653 - *316 - *48 - *17 @@ -95642,7 +95731,7 @@ paths: type: array items: *317 examples: - default: *655 + default: *656 headers: Link: *54 x-github: @@ -95671,7 +95760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 requestBody: required: true @@ -95723,7 +95812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 responses: @@ -95758,7 +95847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 requestBody: @@ -95784,7 +95873,7 @@ paths: application/json: schema: *317 examples: - default: *656 + default: *657 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95809,7 +95898,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 responses: @@ -95840,7 +95929,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 - name: content @@ -95899,7 +95988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *652 + - *653 - *316 - *319 requestBody: @@ -95961,7 +96050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *652 + - *653 - *316 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -96019,7 +96108,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *652 + - *653 - *316 requestBody: required: true @@ -96078,7 +96167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96116,7 +96205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *652 + - *653 - name: role description: Filters members returned by their role in the team. in: query @@ -96167,7 +96256,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96204,7 +96293,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96244,7 +96333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96281,7 +96370,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *652 + - *653 - *59 responses: '200': @@ -96290,7 +96379,7 @@ paths: application/json: schema: *324 examples: - response-if-user-is-a-team-maintainer: *657 + response-if-user-is-a-team-maintainer: *658 '404': *6 x-github: githubCloudOnly: false @@ -96323,7 +96412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *652 + - *653 - *59 requestBody: required: false @@ -96351,7 +96440,7 @@ paths: application/json: schema: *324 examples: - response-if-users-membership-with-team-is-now-pending: *658 + response-if-users-membership-with-team-is-now-pending: *659 '403': description: Forbidden if team synchronization is set up '422': @@ -96385,7 +96474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *652 + - *653 - *59 responses: '204': @@ -96414,7 +96503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96426,7 +96515,7 @@ paths: type: array items: *325 examples: - default: *659 + default: *660 headers: Link: *54 '404': *6 @@ -96452,7 +96541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *652 + - *653 - *326 responses: '200': @@ -96461,7 +96550,7 @@ paths: application/json: schema: *325 examples: - default: *660 + default: *661 '404': description: Not Found if project is not managed by this team x-github: @@ -96485,7 +96574,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *652 + - *653 - *326 requestBody: required: false @@ -96553,7 +96642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *652 + - *653 - *326 responses: '204': @@ -96581,7 +96670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96623,7 +96712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *652 + - *653 - *327 - *328 responses: @@ -96631,7 +96720,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *661 + schema: *662 examples: alternative-response-with-extra-repository-information: value: @@ -96782,7 +96871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *652 + - *653 - *327 - *328 requestBody: @@ -96834,7 +96923,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *652 + - *653 - *327 - *328 responses: @@ -96861,7 +96950,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *652 + - *653 - *17 - *19 responses: @@ -96873,7 +96962,7 @@ paths: type: array items: *181 examples: - response-if-child-teams-exist: *662 + response-if-child-teams-exist: *663 headers: Link: *54 '404': *6 @@ -96906,7 +96995,7 @@ paths: application/json: schema: oneOf: - - &664 + - &665 title: Private User description: Private User type: object @@ -97109,7 +97198,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *663 + - *664 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97262,7 +97351,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *665 examples: default: value: @@ -97660,7 +97749,7 @@ paths: type: integer secrets: type: array - items: &665 + items: &666 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97776,7 +97865,7 @@ paths: description: Response content: application/json: - schema: *665 + schema: *666 examples: default: value: @@ -97922,7 +98011,7 @@ paths: type: array items: *143 examples: - default: *666 + default: *667 '401': *25 '403': *29 '404': *6 @@ -98189,7 +98278,7 @@ paths: description: Response content: application/json: - schema: &667 + schema: &668 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98230,7 +98319,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &668 + default: &669 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98275,9 +98364,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *668 examples: - default: *668 + default: *669 '404': *6 x-github: githubCloudOnly: false @@ -98314,9 +98403,9 @@ paths: type: integer machines: type: array - items: *669 + items: *670 examples: - default: *670 + default: *671 '304': *37 '500': *103 '401': *25 @@ -99255,7 +99344,7 @@ paths: type: array items: *237 examples: - default: &681 + default: &682 value: - id: 197 name: hello_docker @@ -99356,7 +99445,7 @@ paths: application/json: schema: type: array - items: &671 + items: &672 title: Email description: Email type: object @@ -99421,9 +99510,9 @@ paths: application/json: schema: type: array - items: *671 + items: *672 examples: - default: &683 + default: &684 value: - email: octocat@github.com verified: true @@ -99498,7 +99587,7 @@ paths: application/json: schema: type: array - items: *671 + items: *672 examples: default: value: @@ -99754,7 +99843,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: GPG Key description: A unique encryption key type: object @@ -99885,7 +99974,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &698 value: - id: 3 name: Octocat's GPG Key @@ -99970,9 +100059,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: id: 3 name: Octocat's GPG Key @@ -100029,7 +100118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &674 + - &675 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100041,9 +100130,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 '304': *37 '403': *29 @@ -100066,7 +100155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *674 + - *675 responses: '204': description: Response @@ -100521,7 +100610,7 @@ paths: application/json: schema: type: array - items: &675 + items: &676 title: Key description: Key type: object @@ -100622,9 +100711,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *676 examples: - default: &676 + default: &677 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100663,9 +100752,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *676 examples: - default: *676 + default: *677 '404': *6 '304': *37 '403': *29 @@ -100721,7 +100810,7 @@ paths: application/json: schema: type: array - items: &677 + items: &678 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100789,7 +100878,7 @@ paths: - account - plan examples: - default: &678 + default: &679 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100851,9 +100940,9 @@ paths: application/json: schema: type: array - items: *677 + items: *678 examples: - default: *678 + default: *679 headers: Link: *54 '304': *37 @@ -101848,7 +101937,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *231 - - *679 + - *680 responses: '204': description: Response @@ -101963,7 +102052,7 @@ paths: - docker - nuget - container - - *680 + - *681 - *19 - *17 responses: @@ -101975,8 +102064,8 @@ paths: type: array items: *237 examples: - default: *681 - '400': *682 + default: *682 + '400': *683 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102005,7 +102094,7 @@ paths: application/json: schema: *237 examples: - default: &698 + default: &699 value: id: 40201 name: octo-name @@ -102367,9 +102456,9 @@ paths: application/json: schema: type: array - items: *671 + items: *672 examples: - default: *683 + default: *684 headers: Link: *54 '304': *37 @@ -102482,7 +102571,7 @@ paths: type: array items: *66 examples: - default: &690 + default: &691 summary: Default response value: - id: 1296269 @@ -102828,7 +102917,7 @@ paths: type: array items: *522 examples: - default: *684 + default: *685 headers: Link: *54 '304': *37 @@ -102907,7 +102996,7 @@ paths: application/json: schema: type: array - items: &685 + items: &686 title: Social account description: Social media account type: object @@ -102922,7 +103011,7 @@ paths: - provider - url examples: - default: &686 + default: &687 value: - provider: twitter url: https://twitter.com/github @@ -102984,9 +103073,9 @@ paths: application/json: schema: type: array - items: *685 + items: *686 examples: - default: *686 + default: *687 '422': *15 '304': *37 '404': *6 @@ -103073,7 +103162,7 @@ paths: application/json: schema: type: array - items: &687 + items: &688 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103093,7 +103182,7 @@ paths: - title - created_at examples: - default: &706 + default: &707 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103157,9 +103246,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *688 examples: - default: &688 + default: &689 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103189,7 +103278,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: - - &689 + - &690 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103201,9 +103290,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *688 examples: - default: *688 + default: *689 '404': *6 '304': *37 '403': *29 @@ -103226,7 +103315,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: - - *689 + - *690 responses: '204': description: Response @@ -103255,7 +103344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &707 + - &708 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 @@ -103280,11 +103369,11 @@ paths: type: array items: *66 examples: - default-response: *690 + default-response: *691 application/vnd.github.v3.star+json: schema: type: array - items: &708 + items: &709 title: Starred Repository description: Starred Repository type: object @@ -103653,10 +103742,10 @@ paths: application/json: schema: oneOf: + - *665 - *664 - - *663 examples: - default-response: &692 + default-response: &693 summary: Default response value: login: octocat @@ -103691,7 +103780,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &693 + response-with-git-hub-plan-information: &694 summary: Response with GitHub plan information value: login: octocat @@ -103813,7 +103902,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *691 + - *692 - *17 responses: '200': @@ -103862,11 +103951,11 @@ paths: application/json: schema: oneOf: + - *665 - *664 - - *663 examples: - default-response: *692 - response-with-git-hub-plan-information: *693 + default-response: *693 + response-with-git-hub-plan-information: *694 '404': *6 x-github: githubCloudOnly: false @@ -103916,8 +104005,8 @@ paths: required: - subject_digests examples: - default: *694 - withPredicateType: *695 + default: *695 + withPredicateType: *696 responses: '200': description: Response @@ -103970,7 +104059,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *696 + default: *697 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104216,7 +104305,7 @@ paths: type: array items: *237 examples: - default: *681 + default: *682 '403': *29 '401': *25 x-github: @@ -104600,9 +104689,9 @@ paths: application/json: schema: type: array - items: *672 + items: *673 examples: - default: *697 + default: *698 headers: Link: *54 x-github: @@ -104830,7 +104919,7 @@ paths: - docker - nuget - container - - *680 + - *681 - *59 - *19 - *17 @@ -104843,10 +104932,10 @@ paths: type: array items: *237 examples: - default: *681 + default: *682 '403': *29 '401': *25 - '400': *682 + '400': *683 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104876,7 +104965,7 @@ paths: application/json: schema: *237 examples: - default: *698 + default: *699 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105225,7 +105314,7 @@ paths: type: array items: *259 examples: - default: *699 + default: *700 headers: Link: *54 '304': *37 @@ -105236,6 +105325,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: + - *59 + - *255 + 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: *259 + 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': *37 + '403': *29 + '401': *25 + '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 @@ -105248,7 +105588,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *255 - - *700 + - *701 - *59 responses: '200': @@ -105257,7 +105597,7 @@ paths: application/json: schema: *259 examples: - default: *701 + default: *702 headers: Link: *54 '304': *37 @@ -105788,7 +106128,7 @@ paths: - *106 - *108 - *107 - - *702 + - *703 - *109 responses: '200': @@ -105919,7 +106259,7 @@ paths: parameters: - *59 - *106 - - *703 + - *704 - *107 responses: '200': @@ -106018,9 +106358,9 @@ paths: - *106 - *108 - *107 - - *704 - - *109 - *705 + - *109 + - *706 responses: '200': description: Response when getting a billing usage summary @@ -106154,9 +106494,9 @@ paths: application/json: schema: type: array - items: *685 + items: *686 examples: - default: *686 + default: *687 headers: Link: *54 x-github: @@ -106186,9 +106526,9 @@ paths: application/json: schema: type: array - items: *687 + items: *688 examples: - default: *706 + default: *707 headers: Link: *54 x-github: @@ -106213,7 +106553,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *59 - - *707 + - *708 - *48 - *17 - *19 @@ -106225,11 +106565,11 @@ paths: schema: anyOf: - type: array - items: *708 + items: *709 - type: array items: *66 examples: - default-response: *690 + default-response: *691 headers: Link: *54 x-github: @@ -106388,7 +106728,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &709 + enterprise: &710 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106446,7 +106786,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &710 + installation: &711 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106465,7 +106805,7 @@ x-webhooks: required: - id - node_id - organization: &711 + organization: &712 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106525,13 +106865,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &712 + repository: &713 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &742 + properties: &743 id: description: Unique identifier of the repository example: 42 @@ -107214,7 +107554,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &743 + required: &744 - archive_url - assignees_url - blobs_url @@ -107365,10 +107705,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -107444,11 +107784,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: &713 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + rule: &714 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) @@ -107671,11 +108011,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + rule: *714 sender: *4 required: - action @@ -107858,11 +108198,11 @@ x-webhooks: - everyone required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + rule: *714 sender: *4 required: - action @@ -107946,7 +108286,7 @@ x-webhooks: type: string enum: - completed - check_run: &715 + check_run: &716 title: CheckRun description: A check performed on the code of a given code change type: object @@ -108037,7 +108377,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *714 + deployment: *715 details_url: example: https://example.com type: string @@ -108122,10 +108462,10 @@ x-webhooks: - output - app - pull_requests - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 sender: *4 required: - check_run @@ -108518,11 +108858,11 @@ x-webhooks: type: string enum: - created - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *716 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 sender: *4 required: - check_run @@ -108918,11 +109258,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *716 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 requested_action: description: The action requested by the user. type: object @@ -109327,11 +109667,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *716 + installation: *711 + enterprise: *710 + organization: *712 + repository: *713 sender: *4 required: - check_run @@ -110308,10 +110648,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -110584,6 +110924,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -110996,10 +111341,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -111267,6 +111612,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -111678,10 +112028,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -111992,20 +112342,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &716 + commit_oid: &717 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: *709 - installation: *710 - organization: *711 - ref: &717 + enterprise: *710 + installation: *711 + organization: *712 + ref: &718 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: *712 + repository: *713 sender: *4 required: - action @@ -112400,12 +112750,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -112671,12 +113021,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -113008,12 +113358,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -113281,16 +113631,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 ref: 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 nullable: true - repository: *712 + repository: *713 sender: *4 required: - action @@ -113527,12 +113877,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *717 + enterprise: *710 + installation: *711 + organization: *712 + ref: *718 + repository: *713 sender: *4 required: - action @@ -113789,10 +114139,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -113872,18 +114222,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *711 - pusher_type: &718 + organization: *712 + pusher_type: &719 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &719 + ref: &720 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113893,7 +114243,7 @@ x-webhooks: enum: - tag - branch - repository: *712 + repository: *713 sender: *4 required: - ref @@ -113976,9 +114326,9 @@ x-webhooks: enum: - created definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114063,9 +114413,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114143,9 +114493,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114223,9 +114573,9 @@ x-webhooks: enum: - updated definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -114302,10 +114652,10 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - repository: *712 - organization: *711 + enterprise: *710 + installation: *711 + repository: *713 + organization: *712 sender: *4 new_property_values: type: array @@ -114390,18 +114740,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - pusher_type: *718 - ref: *719 + enterprise: *710 + installation: *711 + organization: *712 + pusher_type: *719 + ref: *720 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *712 + repository: *713 sender: *4 required: - ref @@ -114486,10 +114836,10 @@ x-webhooks: enum: - auto_dismissed alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114574,10 +114924,10 @@ x-webhooks: enum: - auto_reopened alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114662,10 +115012,10 @@ x-webhooks: enum: - created alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114748,10 +115098,10 @@ x-webhooks: enum: - dismissed alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114834,10 +115184,10 @@ x-webhooks: enum: - fixed alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -114921,10 +115271,10 @@ x-webhooks: enum: - reintroduced alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -115007,10 +115357,10 @@ x-webhooks: enum: - reopened alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + installation: *711 + organization: *712 + enterprise: *710 + repository: *713 sender: *4 required: - action @@ -115087,9 +115437,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - key: &720 + enterprise: *710 + installation: *711 + key: &721 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115125,8 +115475,8 @@ x-webhooks: - verified - created_at - read_only - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -115203,11 +115553,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - key: *720 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + key: *721 + organization: *712 + repository: *713 sender: *4 required: - action @@ -115768,12 +116118,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: &724 + workflow: &725 title: Workflow type: object nullable: true @@ -116503,9 +116853,9 @@ x-webhooks: pull_requests: type: array items: *571 - repository: *712 - organization: *711 - installation: *710 + repository: *713 + organization: *712 + installation: *711 sender: *4 responses: '200': @@ -116576,7 +116926,7 @@ x-webhooks: type: string enum: - approved - approver: &721 + approver: &722 type: object properties: avatar_url: @@ -116619,11 +116969,11 @@ x-webhooks: type: string comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: &722 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + reviewers: &723 type: array items: type: object @@ -116702,7 +117052,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &723 + workflow_job_run: &724 type: object properties: conclusion: @@ -117433,18 +117783,18 @@ x-webhooks: type: string enum: - rejected - approver: *721 + approver: *722 comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: *722 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + reviewers: *723 sender: *4 since: type: string - workflow_job_run: *723 + workflow_job_run: *724 workflow_job_runs: type: array items: @@ -118148,13 +118498,13 @@ x-webhooks: type: string enum: - requested - enterprise: *709 + enterprise: *710 environment: type: string - installation: *710 - organization: *711 - repository: *712 - requestor: &729 + installation: *711 + organization: *712 + repository: *713 + requestor: &730 title: User type: object nullable: true @@ -120053,12 +120403,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Deployment Workflow Run type: object @@ -120738,7 +121088,7 @@ x-webhooks: type: string enum: - answered - answer: &727 + answer: &728 type: object properties: author_association: @@ -120895,7 +121245,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &725 + discussion: &726 title: Discussion description: A Discussion in a repository. type: object @@ -121203,10 +121553,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121333,11 +121683,11 @@ x-webhooks: - from required: - category - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121420,11 +121770,11 @@ x-webhooks: type: string enum: - closed - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121506,7 +121856,7 @@ x-webhooks: type: string enum: - created - comment: &726 + comment: &727 type: object properties: author_association: @@ -121663,11 +122013,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121750,12 +122100,12 @@ x-webhooks: type: string enum: - deleted - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *727 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121850,12 +122200,12 @@ x-webhooks: - from required: - body - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *727 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -121939,11 +122289,11 @@ x-webhooks: type: string enum: - created - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122025,11 +122375,11 @@ x-webhooks: type: string enum: - deleted - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122129,11 +122479,11 @@ x-webhooks: type: string required: - from - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122215,10 +122565,10 @@ x-webhooks: type: string enum: - labeled - discussion: *725 - enterprise: *709 - installation: *710 - label: &728 + discussion: *726 + enterprise: *710 + installation: *711 + label: &729 title: Label type: object properties: @@ -122250,8 +122600,8 @@ x-webhooks: - color - default - description - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122334,11 +122684,11 @@ x-webhooks: type: string enum: - locked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122420,11 +122770,11 @@ x-webhooks: type: string enum: - pinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122506,11 +122856,11 @@ x-webhooks: type: string enum: - reopened - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122595,16 +122945,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *725 - new_repository: *712 + new_discussion: *726 + new_repository: *713 required: - new_discussion - new_repository - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122687,10 +123037,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *725 - old_answer: *727 - organization: *711 - repository: *712 + discussion: *726 + old_answer: *728 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122772,12 +123122,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *725 - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122860,11 +123210,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -122946,11 +123296,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *726 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -123023,7 +123373,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *709 + enterprise: *710 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123683,9 +124033,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - forkee @@ -123831,9 +124181,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pages: description: The pages that were updated. type: array @@ -123870,7 +124220,7 @@ x-webhooks: - action - sha - html_url - repository: *712 + repository: *713 sender: *4 required: - pages @@ -123946,10 +124296,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: &730 + organization: *712 + repositories: &731 description: An array of repository objects that the installation can access. type: array @@ -123975,8 +124325,8 @@ x-webhooks: - name - full_name - private - repository: *712 - requester: *729 + repository: *713 + requester: *730 sender: *4 required: - action @@ -124051,11 +124401,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124131,11 +124481,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124211,10 +124561,10 @@ x-webhooks: type: string enum: - added - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories_added: &731 + organization: *712 + repositories_added: &732 description: An array of repository objects, which were added to the installation. type: array @@ -124260,15 +124610,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *712 - repository_selection: &732 + repository: *713 + repository_selection: &733 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *729 + requester: *730 sender: *4 required: - action @@ -124347,10 +124697,10 @@ x-webhooks: type: string enum: - removed - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories_added: *731 + organization: *712 + repositories_added: *732 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124377,9 +124727,9 @@ x-webhooks: - name - full_name - private - repository: *712 - repository_selection: *732 - requester: *729 + repository: *713 + repository_selection: *733 + requester: *730 sender: *4 required: - action @@ -124458,11 +124808,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124640,10 +124990,10 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 target_type: type: string @@ -124722,11 +125072,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *709 + enterprise: *710 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *712 + repositories: *731 + repository: *713 requester: nullable: true sender: *4 @@ -124978,8 +125328,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125773,8 +126123,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126123,8 +126473,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -126204,7 +126554,7 @@ x-webhooks: type: string enum: - deleted - comment: &733 + comment: &734 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126369,8 +126719,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127160,8 +127510,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127512,8 +127862,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -127593,7 +127943,7 @@ x-webhooks: type: string enum: - edited - changes: &762 + changes: &763 description: The changes to the comment. type: object properties: @@ -127605,9 +127955,9 @@ x-webhooks: type: string required: - from - comment: *733 - enterprise: *709 - installation: *710 + comment: *734 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128400,8 +128750,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128750,8 +129100,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -128841,9 +129191,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -128937,9 +129287,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -129032,9 +129382,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -129128,9 +129478,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -129215,10 +129565,10 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - issue: &736 + assignee: *730 + enterprise: *710 + installation: *711 + issue: &737 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130007,11 +130357,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130128,8 +130478,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -130209,8 +130559,8 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -131004,11 +131354,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131260,8 +131610,8 @@ x-webhooks: required: - state - closed_at - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -131340,8 +131690,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,11 +132476,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132246,8 +132596,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -132326,8 +132676,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133134,11 +133484,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133233,7 +133583,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &734 + milestone: &735 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133371,8 +133721,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -133471,8 +133821,8 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134261,11 +134611,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134382,9 +134732,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -134464,8 +134814,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135253,11 +135603,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135374,9 +135724,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -135456,8 +135806,8 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136269,11 +136619,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136367,8 +136717,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -136447,8 +136797,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137254,11 +137604,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137352,9 +137702,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *734 - organization: *711 - repository: *712 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -138222,11 +138572,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138788,8 +139138,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139578,11 +139928,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139698,8 +140048,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -139779,9 +140129,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *709 - installation: *710 - issue: &735 + enterprise: *710 + installation: *711 + issue: &736 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140564,11 +140914,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140684,8 +141034,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -140764,8 +141114,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141575,11 +141925,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141674,8 +142024,8 @@ x-webhooks: user_view_type: type: string type: *219 - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -142541,11 +142891,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143129,11 +143479,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *736 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143213,12 +143563,12 @@ x-webhooks: type: string enum: - typed - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *710 + installation: *711 + issue: *737 type: *219 - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143299,7 +143649,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &766 title: User type: object nullable: true @@ -143369,11 +143719,11 @@ x-webhooks: required: - login - id - enterprise: *709 - installation: *710 - issue: *736 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *737 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143452,12 +143802,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - issue: *736 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *737 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -143537,8 +143887,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144348,11 +144698,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *650 + issue_dependencies_summary: *651 issue_field_values: type: array - items: *651 + items: *652 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144446,8 +144796,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144527,11 +144877,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + issue: *736 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144610,12 +144960,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *709 - installation: *710 - issue: *736 + enterprise: *710 + installation: *711 + issue: *737 type: *219 - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144695,11 +145045,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144777,11 +145127,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144891,11 +145241,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + label: *729 + organization: *712 + repository: *713 sender: *4 required: - action @@ -144977,9 +145327,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: &737 + enterprise: *710 + installation: *711 + marketplace_purchase: &738 title: Marketplace Purchase type: object required: @@ -145062,8 +145412,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: &738 + organization: *712 + previous_marketplace_purchase: &739 title: Marketplace Purchase type: object properties: @@ -145143,7 +145493,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *713 sender: *4 required: - action @@ -145223,10 +145573,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *710 + installation: *711 + marketplace_purchase: *738 + organization: *712 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145309,7 +145659,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *713 sender: *4 required: - action @@ -145391,10 +145741,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *710 + installation: *711 + marketplace_purchase: *738 + organization: *712 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145476,7 +145826,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *713 sender: *4 required: - action @@ -145557,8 +145907,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 marketplace_purchase: title: Marketplace Purchase type: object @@ -145640,9 +145990,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + organization: *712 + previous_marketplace_purchase: *739 + repository: *713 sender: *4 required: - action @@ -145722,12 +146072,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + enterprise: *710 + installation: *711 + marketplace_purchase: *738 + organization: *712 + previous_marketplace_purchase: *739 + repository: *713 sender: *4 required: - action @@ -145829,11 +146179,11 @@ x-webhooks: type: string required: - to - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 sender: *4 required: - action @@ -145933,11 +146283,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146016,11 +146366,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146098,11 +146448,11 @@ x-webhooks: type: string enum: - added - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146178,7 +146528,7 @@ x-webhooks: required: - login - id - team: &739 + team: &740 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146401,11 +146751,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + member: *730 + organization: *712 + repository: *713 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146482,7 +146832,7 @@ x-webhooks: required: - login - id - team: *739 + team: *740 required: - action - scope @@ -146564,8 +146914,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *710 - merge_group: &741 + installation: *711 + merge_group: &742 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146584,15 +146934,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *740 + head_commit: *741 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146678,10 +147028,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *710 - merge_group: *741 - organization: *711 - repository: *712 + installation: *711 + merge_group: *742 + organization: *712 + repository: *713 sender: *4 required: - action @@ -146754,7 +147104,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *710 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146863,16 +147213,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *710 - organization: *711 + installation: *711 + organization: *712 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -146953,11 +147303,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147036,9 +147386,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - milestone: &744 + enterprise: *710 + installation: *711 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147175,8 +147525,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147255,11 +147605,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147369,11 +147719,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *735 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147453,11 +147803,11 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - milestone: *744 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + milestone: *745 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147536,11 +147886,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *730 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147619,11 +147969,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *730 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147702,9 +148052,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - membership: &745 + enterprise: *710 + installation: *711 + membership: &746 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147811,8 +148161,8 @@ x-webhooks: - role - organization_url - user - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147890,11 +148240,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + membership: *746 + organization: *712 + repository: *713 sender: *4 required: - action @@ -147973,8 +148323,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148090,10 +148440,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 - user: *729 + user: *730 required: - action - invitation @@ -148171,11 +148521,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + membership: *746 + organization: *712 + repository: *713 sender: *4 required: - action @@ -148262,11 +148612,11 @@ x-webhooks: properties: from: type: string - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + membership: *746 + organization: *712 + repository: *713 sender: *4 required: - action @@ -148342,9 +148692,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 package: description: Information about the package. type: object @@ -148843,7 +149193,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &746 + items: &747 title: Ruby Gems metadata type: object properties: @@ -148938,7 +149288,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -149014,9 +149364,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 package: description: Information about the package. type: object @@ -149369,7 +149719,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *747 source_url: type: string format: uri @@ -149439,7 +149789,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -149616,12 +149966,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *709 + enterprise: *710 id: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - id @@ -149698,7 +150048,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &747 + personal_access_token_request: &748 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149844,10 +150194,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *709 - organization: *711 + enterprise: *710 + organization: *712 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -149924,11 +150274,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *748 + enterprise: *710 + organization: *712 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -150004,11 +150354,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *748 + enterprise: *710 + organization: *712 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -150083,11 +150433,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *747 - organization: *711 - enterprise: *709 + personal_access_token_request: *748 + organization: *712 + enterprise: *710 sender: *4 - installation: *710 + installation: *711 required: - action - personal_access_token_request @@ -150192,7 +150542,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *748 + last_response: *749 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150224,8 +150574,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 zen: description: Random string of GitHub zen. @@ -150470,10 +150820,10 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: &749 + enterprise: *710 + installation: *711 + organization: *712 + project_card: &750 title: Project Card type: object properties: @@ -150592,7 +150942,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *713 sender: *4 required: - action @@ -150673,11 +151023,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_card: *750 + repository: *713 sender: *4 required: - action @@ -150757,9 +151107,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 project_card: title: Project Card type: object @@ -150887,8 +151237,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -150982,11 +151332,11 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_card: *750 + repository: *713 sender: *4 required: - action @@ -151080,9 +151430,9 @@ x-webhooks: - from required: - column_id - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 project_card: allOf: - title: Project Card @@ -151272,7 +151622,7 @@ x-webhooks: type: string required: - after_id - repository: *712 + repository: *713 sender: *4 required: - action @@ -151352,10 +151702,10 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - organization: *711 - project: &751 + enterprise: *710 + installation: *711 + organization: *712 + project: &752 title: Project type: object properties: @@ -151479,7 +151829,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *713 sender: *4 required: - action @@ -151559,10 +151909,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_column: &750 + enterprise: *710 + installation: *711 + organization: *712 + project_column: &751 title: Project Column type: object properties: @@ -151601,7 +151951,7 @@ x-webhooks: - name - created_at - updated_at - repository: *712 + repository: *713 sender: *4 required: - action @@ -151680,18 +152030,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 + enterprise: *710 + installation: *711 + organization: *712 + project_column: *751 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -151781,11 +152131,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_column: *751 + repository: *713 sender: *4 required: - action @@ -151865,11 +152215,11 @@ x-webhooks: type: string enum: - moved - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project_column: *751 + repository: *713 sender: *4 required: - action @@ -151949,11 +152299,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 + repository: *713 sender: *4 required: - action @@ -152033,18 +152383,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project: *751 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *743 + required: *744 nullable: true sender: *4 required: @@ -152146,11 +152496,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 + repository: *713 sender: *4 required: - action @@ -152229,11 +152579,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + project: *752 + repository: *713 sender: *4 required: - action @@ -152314,8 +152664,8 @@ x-webhooks: type: string enum: - closed - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152397,8 +152747,8 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152480,8 +152830,8 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152599,8 +152949,8 @@ x-webhooks: type: string to: type: string - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -152684,7 +153034,7 @@ x-webhooks: type: string enum: - archived - changes: &755 + changes: &756 type: object properties: archived_at: @@ -152698,9 +153048,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *710 - organization: *711 - projects_v2_item: &752 + installation: *711 + organization: *712 + projects_v2_item: &753 title: Projects v2 Item description: An item belonging to a project type: object @@ -152835,9 +153185,9 @@ x-webhooks: nullable: true to: type: string - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -152919,9 +153269,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153002,9 +153352,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153110,7 +153460,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &753 + - &754 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153132,7 +153482,7 @@ x-webhooks: required: - id - name - - &754 + - &755 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153166,8 +153516,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *753 - *754 + - *755 required: - field_value - type: object @@ -153183,9 +153533,9 @@ x-webhooks: nullable: true required: - body - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153280,9 +153630,9 @@ x-webhooks: to: type: string nullable: true - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153365,10 +153715,10 @@ x-webhooks: type: string enum: - restored - changes: *755 - installation: *710 - organization: *711 - projects_v2_item: *752 + changes: *756 + installation: *711 + organization: *712 + projects_v2_item: *753 sender: *4 required: - action @@ -153450,8 +153800,8 @@ x-webhooks: type: string enum: - reopened - installation: *710 - organization: *711 + installation: *711 + organization: *712 projects_v2: *253 sender: *4 required: @@ -153533,14 +153883,14 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_status_update: &758 + installation: *711 + organization: *712 + projects_v2_status_update: &759 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *756 - required: *757 + properties: *757 + required: *758 sender: *4 required: - action @@ -153621,9 +153971,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *711 + organization: *712 + projects_v2_status_update: *759 sender: *4 required: - action @@ -153759,9 +154109,9 @@ x-webhooks: type: string format: date nullable: true - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *711 + organization: *712 + projects_v2_status_update: *759 sender: *4 required: - action @@ -153832,10 +154182,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - repository @@ -153912,13 +154262,13 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - number: &759 + assignee: *730 + enterprise: *710 + installation: *711 + number: &760 description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -156201,7 +156551,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -156283,11 +156633,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -158565,7 +158915,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *713 sender: *4 required: - action @@ -158647,11 +158997,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -160929,7 +161279,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *713 sender: *4 required: - action @@ -161011,11 +161361,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: &760 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: &761 allOf: - *571 - type: object @@ -161079,7 +161429,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *712 + repository: *713 sender: *4 required: - action @@ -161160,12 +161510,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -161245,11 +161595,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 + enterprise: *710 milestone: *553 - number: *759 - organization: *711 - pull_request: &761 + number: *760 + organization: *712 + pull_request: &762 title: Pull Request type: object properties: @@ -163512,7 +163862,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -163591,11 +163941,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -165877,7 +166227,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *712 + repository: *713 sender: *4 required: - action @@ -166001,12 +166351,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -166086,11 +166436,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -168357,7 +168707,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -168437,11 +168787,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + label: *729 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -170723,7 +171073,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -170804,10 +171154,10 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -173087,7 +173437,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -173167,12 +173517,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 + enterprise: *710 milestone: *553 - number: *759 - organization: *711 - pull_request: *761 - repository: *712 + number: *760 + organization: *712 + pull_request: *762 + repository: *713 sender: *4 required: - action @@ -173251,12 +173601,12 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -173337,12 +173687,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -173422,12 +173772,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 + pull_request: *761 + repository: *713 sender: *4 required: - action @@ -173793,9 +174143,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: type: object properties: @@ -175965,7 +176315,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *713 sender: *4 required: - action @@ -176045,7 +176395,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &764 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176330,9 +176680,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: type: object properties: @@ -178490,7 +178840,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *713 sender: *4 required: - action @@ -178570,11 +178920,11 @@ x-webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *709 - installation: *710 - organization: *711 + changes: *763 + comment: *764 + enterprise: *710 + installation: *711 + organization: *712 pull_request: type: object properties: @@ -180735,7 +181085,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *713 sender: *4 required: - action @@ -180816,9 +181166,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -182991,7 +183341,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *713 review: description: The review that was affected. type: object @@ -183238,9 +183588,9 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -185294,8 +185644,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: &764 + repository: *713 + review: &765 description: The review that was affected. type: object properties: @@ -185528,12 +185878,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -187816,7 +188166,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_reviewer: title: User type: object @@ -187900,12 +188250,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -190195,7 +190545,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190387,12 +190737,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -192677,7 +193027,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_reviewer: title: User type: object @@ -192762,12 +193112,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *710 + installation: *711 number: description: The pull request number. type: integer - organization: *711 + organization: *712 pull_request: title: Pull Request type: object @@ -195043,7 +195393,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195224,9 +195574,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -197401,8 +197751,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: *764 + repository: *713 + review: *765 sender: *4 required: - action @@ -197482,9 +197832,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -199554,7 +199904,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *713 sender: *4 thread: type: object @@ -199941,9 +200291,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 pull_request: title: Simple Pull Request type: object @@ -201999,7 +202349,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *713 sender: *4 thread: type: object @@ -202389,10 +202739,10 @@ x-webhooks: type: string before: type: string - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -204663,7 +205013,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -204745,11 +205095,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + assignee: *766 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -207032,7 +207382,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -207111,11 +207461,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + label: *729 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -209388,7 +209738,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -209469,10 +209819,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *710 + installation: *711 + number: *760 + organization: *712 pull_request: title: Pull Request type: object @@ -211737,7 +212087,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *713 sender: *4 required: - action @@ -211937,7 +212287,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *709 + enterprise: *710 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212029,8 +212379,8 @@ x-webhooks: - url - author - committer - installation: *710 - organization: *711 + installation: *711 + organization: *712 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212605,9 +212955,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 registry_package: type: object properties: @@ -213053,7 +213403,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *746 + items: *747 summary: type: string tag_name: @@ -213107,7 +213457,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -213185,9 +213535,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 registry_package: type: object properties: @@ -213495,7 +213845,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *747 summary: type: string tag_name: @@ -213544,7 +213894,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *713 sender: *4 required: - action @@ -213621,10 +213971,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - release: &766 + enterprise: *710 + installation: *711 + organization: *712 + release: &767 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213942,7 +214292,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *712 + repository: *713 sender: *4 required: - action @@ -214019,11 +214369,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *767 + repository: *713 sender: *4 required: - action @@ -214140,11 +214490,11 @@ x-webhooks: type: boolean required: - to - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *767 + repository: *713 sender: *4 required: - action @@ -214222,9 +214572,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214546,7 +214896,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *713 sender: *4 required: - action @@ -214622,10 +214972,10 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - release: &767 + enterprise: *710 + installation: *711 + organization: *712 + release: &768 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214944,7 +215294,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *713 sender: *4 required: - action @@ -215020,11 +215370,11 @@ x-webhooks: type: string enum: - released - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *767 + repository: *713 sender: *4 required: - action @@ -215100,11 +215450,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *709 - installation: *710 - organization: *711 - release: *767 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + release: *768 + repository: *713 sender: *4 required: - action @@ -215180,11 +215530,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + repository_advisory: *636 sender: *4 required: - action @@ -215260,11 +215610,11 @@ x-webhooks: type: string enum: - reported - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + repository_advisory: *636 sender: *4 required: - action @@ -215340,10 +215690,10 @@ x-webhooks: type: string enum: - archived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215420,10 +215770,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215501,10 +215851,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215588,10 +215938,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215703,10 +216053,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215778,10 +216128,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 status: type: string @@ -215862,10 +216212,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -215942,10 +216292,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216039,10 +216389,10 @@ x-webhooks: - name required: - repository - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216122,10 +216472,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 repository_ruleset: *298 sender: *4 required: @@ -216204,10 +216554,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 repository_ruleset: *298 sender: *4 required: @@ -216286,10 +216636,10 @@ x-webhooks: type: string enum: - edited - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 repository_ruleset: *298 changes: type: object @@ -216594,10 +216944,10 @@ x-webhooks: - from required: - owner - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216675,10 +217025,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -216756,7 +217106,7 @@ x-webhooks: type: string enum: - create - alert: &768 + alert: &769 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216877,10 +217227,10 @@ x-webhooks: type: string enum: - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217086,10 +217436,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217167,11 +217517,11 @@ x-webhooks: type: string enum: - reopen - alert: *768 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *769 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217370,10 +217720,10 @@ x-webhooks: enum: - fixed - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217391,7 +217741,7 @@ x-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. @@ -217399,8 +217749,8 @@ x-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: @@ -217444,14 +217794,14 @@ x-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: &769 + - assigned + alert: &770 type: object properties: number: *161 @@ -217569,10 +217919,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + assignee: *4 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + 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: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217653,11 +218086,11 @@ x-webhooks: type: string enum: - created - alert: *769 - installation: *710 - location: *770 - organization: *711 - repository: *712 + alert: *770 + installation: *711 + location: *771 + organization: *712 + repository: *713 sender: *4 required: - location @@ -217895,11 +218328,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -217977,11 +218410,11 @@ x-webhooks: type: string enum: - reopened - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -218059,11 +218492,94 @@ x-webhooks: type: string enum: - resolved - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + 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: *770 + assignee: *4 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -218141,11 +218657,11 @@ x-webhooks: type: string enum: - validated - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *770 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -218271,10 +218787,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *712 - enterprise: *709 - installation: *710 - organization: *711 + repository: *713 + enterprise: *710 + installation: *711 + organization: *712 sender: *4 required: - action @@ -218352,11 +218868,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: &771 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + security_advisory: &772 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218539,11 +219055,11 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: *771 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 + security_advisory: *772 sender: *4 required: - action @@ -218616,10 +219132,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218804,9 +219320,9 @@ x-webhooks: type: object properties: security_and_analysis: *272 - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: *333 sender: *4 required: @@ -218885,12 +219401,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: &772 + sponsorship: &773 type: object properties: created_at: @@ -219191,12 +219707,12 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - sponsorship @@ -219284,12 +219800,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - changes @@ -219366,17 +219882,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &774 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: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - sponsorship @@ -219450,7 +219966,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &775 type: object properties: tier: @@ -219494,13 +220010,13 @@ x-webhooks: - from required: - tier - effective_date: *773 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + effective_date: *774 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - changes @@ -219577,13 +220093,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + changes: *775 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - sponsorship: *772 + sponsorship: *773 required: - action - changes @@ -219657,10 +220173,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219743,10 +220259,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220166,15 +220682,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *709 + enterprise: *710 id: description: The unique identifier of the status. type: integer - installation: *710 + installation: *711 name: type: string - organization: *711 - repository: *712 + organization: *712 + repository: *713 sender: *4 sha: description: The Commit SHA. @@ -220289,9 +220805,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220381,9 +220897,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220473,9 +220989,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220565,9 +221081,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -220644,12 +221160,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - team: &775 + team: &776 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220872,9 +221388,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -221332,7 +221848,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -221408,9 +221924,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -221868,7 +222384,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -221945,9 +222461,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -222405,7 +222921,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -222549,9 +223065,9 @@ x-webhooks: - from required: - permissions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -223009,7 +223525,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - changes @@ -223087,9 +223603,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *710 + installation: *711 + organization: *712 repository: title: Repository description: A git repository @@ -223547,7 +224063,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *776 required: - action - team @@ -223623,10 +224139,10 @@ x-webhooks: type: string enum: - started - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 required: - action @@ -223699,16 +224215,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *709 + enterprise: *710 inputs: type: object nullable: true additionalProperties: true - installation: *710 - organization: *711 + installation: *711 + organization: *712 ref: type: string - repository: *712 + repository: *713 sender: *4 workflow: type: string @@ -223790,10 +224306,10 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: allOf: @@ -224109,10 +224625,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: allOf: @@ -224451,10 +224967,10 @@ x-webhooks: type: string enum: - queued - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: type: object @@ -224668,10 +225184,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 workflow_job: type: object @@ -224887,12 +225403,12 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -225891,12 +226407,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Workflow Run type: object @@ -226880,12 +227396,12 @@ x-webhooks: type: string enum: - requested - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *710 + installation: *711 + organization: *712 + repository: *713 sender: *4 - workflow: *724 + workflow: *725 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index cf7f65190..1cde416c3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -4734,6 +4734,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.", @@ -5735,6 +5743,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.", @@ -6590,6 +6606,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.", @@ -7076,6 +7100,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.", @@ -9117,6 +9149,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.", @@ -10169,6 +10209,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.", @@ -11138,6 +11186,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.", @@ -11818,6 +11874,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.", @@ -27409,6 +27473,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.", @@ -28205,6 +28277,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.", @@ -29157,6 +29237,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.", @@ -30500,6 +30588,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.", @@ -59354,6 +59450,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.", @@ -63078,7 +63197,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" + ] + } + } } } } @@ -151668,6 +151802,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.", @@ -152684,6 +152826,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.", @@ -189145,21 +189295,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", @@ -218162,6 +218330,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.", @@ -277562,6 +277753,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -277582,6 +277774,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295780,6 +295973,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295800,6 +295994,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333647,6 +333842,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333667,6 +333863,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339401,6 +339598,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339421,6 +339619,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344754,6 +344953,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344774,6 +344974,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345300,6 +345501,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345320,6 +345522,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345870,6 +346073,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345890,6 +346094,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -381848,6 +382053,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.", @@ -464232,6 +464445,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -464252,6 +464466,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495105,6 +495320,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495125,6 +495341,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -526189,6 +526406,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.", @@ -528429,7 +528669,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" @@ -528499,6 +528739,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -528506,6 +528751,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -528515,6 +528765,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -529491,7 +529753,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 + } } } } @@ -529505,7 +529787,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", @@ -566791,6 +567073,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -567003,6 +567286,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -608846,6 +609130,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.", @@ -657687,6 +657979,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.", @@ -664124,51 +664424,720 @@ "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { @@ -664369,21 +665338,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", @@ -724616,6 +725603,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -726997,6 +727991,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -858270,6 +859271,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.", @@ -860878,6 +861887,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.", @@ -863393,6 +864410,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.", @@ -865908,6 +866933,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.", @@ -868555,6 +869588,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.", @@ -871209,6 +872250,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.", @@ -875486,6 +876535,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.", @@ -1272142,200 +1273199,3589 @@ "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1273843,7 +1278289,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1273859,23 +1278305,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": [ { @@ -1273940,15 +1278384,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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).\"", @@ -1275455,6 +1280075,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1275470,21 +1280091,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" }, @@ -1275551,13 +1280170,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": { @@ -1277256,11 +1281875,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" }, @@ -1277327,13 +1281946,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": { @@ -1277344,9 +1281963,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1277366,10 +1281982,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1277465,9 +1282077,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1277507,7 +1282116,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1279014,279 +1283624,855 @@ "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": { + "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, + "nullable": 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", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1280795,8 +1285981,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1280810,21 +1285995,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": [ { @@ -1280889,179 +1286075,630 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1282572,8 +1288209,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1282587,21 +1288223,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": [ { @@ -1282666,7 +1288303,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1283293,74 +1288930,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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1283382,6 +1288951,314 @@ "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.", + "example": "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", + "example": "/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", + "example": "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", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", @@ -1284798,10 +1290675,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" + } + } } } } @@ -1284813,8 +1290865,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1284823,13 +1290876,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": [ { @@ -1284894,13 +1290947,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": { @@ -1285521,6 +1291574,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1285542,314 +1291663,6 @@ "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.", - "example": "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", - "example": "/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", - "example": "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", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", @@ -1287266,185 +1293079,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" - } - } } } } @@ -1287456,9 +1293094,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1287467,11 +1293104,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" }, @@ -1287538,13 +1293175,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": { @@ -1289695,11 +1295332,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" }, @@ -1289766,13 +1295403,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": { @@ -1291923,11 +1297560,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" }, @@ -1291994,13 +1297631,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": { @@ -1292621,6 +1298258,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index e891ea64d..1d9b1ff4d 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -865,7 +865,7 @@ paths: - subscriptions_url - type - url - type: &428 + type: &429 type: string description: The type of credit the user is receiving. enum: @@ -1031,7 +1031,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: - - &750 + - &751 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1715,7 +1715,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &761 title: Scim Error description: Scim Error type: object @@ -2217,6 +2217,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 @@ -8740,7 +8747,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &762 description: Authorization failure '404': *6 x-github: @@ -12943,7 +12950,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &535 + instances_url: &536 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12978,7 +12985,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &536 + dismissed_reason: &537 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12987,13 +12994,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &537 + dismissed_comment: &538 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &538 + rule: &539 type: object properties: id: @@ -13046,7 +13053,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &539 + tool: &540 type: object properties: name: *107 @@ -13056,15 +13063,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *108 - most_recent_instance: &540 + most_recent_instance: &541 type: object properties: - ref: &533 + ref: &534 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &550 + analysis_key: &551 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13075,7 +13082,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &552 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -16764,7 +16771,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 - - &590 + - &591 name: has in: query description: |- @@ -16877,7 +16884,7 @@ paths: - unknown - direct - transitive - security_advisory: &591 + security_advisory: &592 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17109,7 +17116,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: &592 + auto_dismissed_at: &593 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -18247,7 +18254,7 @@ paths: - name - created_on examples: - default: &433 + default: &434 value: total_count: 2 network_configurations: @@ -18470,7 +18477,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: - *41 - - &434 + - &435 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18482,7 +18489,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &436 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18516,7 +18523,7 @@ paths: - subnet_id - region examples: - default: &436 + default: &437 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20522,7 +20529,7 @@ paths: - *160 rules: type: array - items: &716 + items: &717 title: Repository Rule type: object description: A repository rule. @@ -20531,7 +20538,7 @@ paths: - *166 - *167 - *168 - - &713 + - &714 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20625,7 +20632,7 @@ paths: - *182 - *183 - *184 - - &714 + - &715 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21020,6 +21027,25 @@ paths: schema: type: string - &419 + 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 + - &420 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. @@ -21035,7 +21061,7 @@ paths: - *17 - *104 - *105 - - &420 + - &421 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21044,7 +21070,7 @@ paths: required: false schema: type: string - - &421 + - &422 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21053,7 +21079,7 @@ paths: schema: type: boolean default: false - - &422 + - &423 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21062,7 +21088,7 @@ paths: schema: type: boolean default: false - - &423 + - &424 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21078,7 +21104,7 @@ paths: application/json: schema: type: array - items: &424 + items: &425 type: object properties: number: *123 @@ -21097,14 +21123,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &728 + state: &729 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: &729 + resolution: &730 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21211,8 +21237,8 @@ paths: pull request. ' - oneOf: &730 - - &732 + oneOf: &731 + - &733 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21264,7 +21290,7 @@ paths: - blob_url - commit_sha - commit_url - - &733 + - &734 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. @@ -21319,7 +21345,7 @@ paths: - page_url - commit_sha - commit_url - - &734 + - &735 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21333,7 +21359,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &735 + - &736 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21347,7 +21373,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &736 + - &737 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21361,7 +21387,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &737 + - &738 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21375,7 +21401,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &738 + - &739 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21389,7 +21415,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &739 + - &740 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21403,7 +21429,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &740 + - &741 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. @@ -21417,7 +21443,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &741 + - &742 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. @@ -21431,7 +21457,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &742 + - &743 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. @@ -21445,7 +21471,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &743 + - &744 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. @@ -21459,7 +21485,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &744 + - &745 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. @@ -21486,7 +21512,7 @@ paths: required: *21 nullable: true examples: - default: &425 + default: &426 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21695,7 +21721,7 @@ paths: description: Response content: application/json: - schema: &426 + schema: &427 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -21778,7 +21804,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &427 + default: &428 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21914,7 +21940,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &430 + - &431 name: advanced_security_product in: query description: | @@ -21934,7 +21960,7 @@ paths: description: Success content: application/json: - schema: &431 + schema: &432 type: object properties: total_advanced_security_committers: @@ -21989,7 +22015,7 @@ paths: required: - repositories examples: - default: &432 + default: &433 value: total_advanced_security_committers: 2 total_count: 2 @@ -22615,7 +22641,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': *25 '403': *29 @@ -24702,7 +24740,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &650 + properties: &651 id: type: integer format: int64 @@ -25074,7 +25112,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &789 title: Sub-issues Summary type: object properties: @@ -25094,7 +25132,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &789 + issue_dependencies_summary: &790 title: Issue Dependencies Summary type: object properties: @@ -25113,7 +25151,7 @@ paths: - total_blocking issue_field_values: type: array - items: &790 + items: &791 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25173,7 +25211,7 @@ paths: - node_id - data_type - value - required: &651 + required: &652 - assignee - closed_at - comments @@ -25194,7 +25232,7 @@ paths: - user - created_at - updated_at - comment: &648 + comment: &649 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25752,7 +25790,7 @@ paths: url: type: string format: uri - user: &802 + user: &803 title: Public User description: Public User type: object @@ -29057,14 +29095,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: - - &456 + - &457 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &457 + - &458 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29126,7 +29164,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &468 + '301': &469 description: Moved permanently content: application/json: @@ -29148,7 +29186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &680 + - &681 name: all description: If `true`, show notifications marked as read. in: query @@ -29156,7 +29194,7 @@ paths: schema: type: boolean default: false - - &681 + - &682 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29166,7 +29204,7 @@ paths: type: boolean default: false - *217 - - &682 + - &683 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: @@ -29648,7 +29686,7 @@ paths: - url - subscription_url examples: - default: &683 + default: &684 value: - id: '1' repository: @@ -30619,7 +30657,7 @@ paths: type: array items: *151 examples: - default: &689 + default: &690 value: - property_name: environment value: production @@ -30669,7 +30707,7 @@ paths: required: - properties examples: - default: &690 + default: &691 value: properties: - property_name: environment @@ -31482,7 +31520,7 @@ paths: type: integer repository_cache_usages: type: array - items: &473 + items: &474 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -33596,7 +33634,7 @@ paths: type: array items: *274 examples: - default: &805 + default: &806 value: total_count: 1 repositories: @@ -34638,7 +34676,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &494 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34667,7 +34705,7 @@ paths: - key_id - key examples: - default: &494 + default: &495 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35080,7 +35118,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *83 - - &478 + - &479 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)." @@ -36262,12 +36300,12 @@ paths: required: - subject_digests examples: - default: &833 + default: &834 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &834 + withPredicateType: &835 value: subject_digests: - sha256:abc123 @@ -36325,7 +36363,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &835 + default: &836 value: attestations_subject_digests: - sha256:abc: @@ -36674,7 +36712,7 @@ paths: initiator: type: string examples: - default: &507 + default: &508 value: attestations: - bundle: @@ -37591,7 +37629,7 @@ paths: be returned. in: query required: false - schema: &534 + schema: &535 type: string description: Severity of a code scanning alert. enum: @@ -38637,7 +38675,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &563 + properties: &564 name: type: string description: The name of the machine. @@ -38679,7 +38717,7 @@ paths: - ready - in_progress nullable: true - required: &564 + required: &565 - name - display_name - operating_system @@ -39547,7 +39585,7 @@ paths: - updated_at - visibility examples: - default: &565 + default: &566 value: total_count: 2 secrets: @@ -39585,7 +39623,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &567 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39614,7 +39652,7 @@ paths: - key_id - key examples: - default: &567 + default: &568 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39646,7 +39684,7 @@ paths: application/json: schema: *318 examples: - default: &569 + default: &570 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -41355,7 +41393,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41372,7 +41410,7 @@ paths: - key_id - key examples: - default: &596 + default: &597 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41702,7 +41740,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - &604 + - &605 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41710,7 +41748,7 @@ paths: required: false schema: type: string - - &605 + - &606 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41718,7 +41756,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: time_period description: |- The time period to filter by. @@ -41734,7 +41772,7 @@ paths: - week - month default: month - - &607 + - &608 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41759,7 +41797,7 @@ paths: application/json: schema: type: array - items: &608 + items: &609 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41915,7 +41953,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &609 + default: &610 value: - id: 21 number: 42 @@ -42006,7 +42044,7 @@ paths: - *99 - *100 - *101 - - &610 + - &611 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42032,7 +42070,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42153,7 +42191,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &612 + default: &613 value: - id: 21 number: 42 @@ -42498,7 +42536,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &452 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -42579,7 +42617,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &452 + default: &453 value: group_id: '123' group_name: Octocat admins @@ -42634,7 +42672,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &450 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42671,7 +42709,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &450 + default: &451 value: groups: - group_id: '123' @@ -43973,7 +44011,7 @@ paths: application/json: schema: *22 examples: - default: &643 + default: &644 value: id: 1 account: @@ -44198,7 +44236,7 @@ paths: required: true content: application/json: - schema: &644 + schema: &645 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -45059,7 +45097,7 @@ paths: application/json: schema: *365 examples: - default: &562 + default: &563 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -46304,7 +46342,7 @@ paths: parameters: - *83 - *371 - - &818 + - &819 name: repo_name description: repo_name parameter in: path @@ -47336,7 +47374,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &429 + items: &430 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -47630,7 +47668,7 @@ paths: - nuget - container - *83 - - &819 + - &820 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47671,7 +47709,7 @@ paths: default: *377 '403': *29 '401': *25 - '400': &821 + '400': &822 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -49463,7 +49501,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &898 + properties: &899 id: type: number description: The unique identifier of the status update. @@ -49511,7 +49549,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &899 + required: &900 - id - node_id - created_at @@ -49725,7 +49763,7 @@ paths: content: oneOf: - *227 - - &577 + - &578 title: Pull Request Simple description: Pull Request Simple type: object @@ -49954,7 +49992,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: &692 + auto_merge: &693 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50329,7 +50367,7 @@ paths: - updated_at - project_url examples: - default: &838 + default: &839 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50461,7 +50499,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - *394 - - &839 + - &840 name: field_id description: The unique identifier of the field. in: path @@ -50476,7 +50514,7 @@ paths: application/json: schema: *398 examples: - default: &840 + default: &841 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50485,17 +50523,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: @@ -52251,7 +52301,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &468 title: Full Repository description: Full Repository type: object @@ -52644,7 +52694,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &582 + properties: &583 url: type: string format: uri @@ -52660,7 +52710,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &583 + required: &584 - url - key - name @@ -52749,7 +52799,7 @@ paths: - network_count - subscribers_count examples: - default: &469 + default: &470 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -53302,7 +53352,7 @@ paths: - *83 - *17 - *19 - - &715 + - &716 name: targets description: | A comma-separated list of rule targets to filter by. @@ -53516,7 +53566,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *83 - - &717 + - &718 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 @@ -53528,14 +53578,14 @@ paths: x-multi-segment: true - *300 - *101 - - &718 + - &719 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 - - &719 + - &720 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53555,7 +53605,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &721 title: Rule Suites description: Response type: array @@ -53610,7 +53660,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &721 + default: &722 value: - id: 21 actor_id: 12 @@ -53654,7 +53704,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *83 - - &722 + - &723 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53670,7 +53720,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &724 title: Rule Suite description: Response type: object @@ -53769,7 +53819,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &724 + default: &725 value: id: 21 actor_id: 12 @@ -54097,10 +54147,11 @@ paths: - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - &726 + - &727 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 @@ -54110,7 +54161,7 @@ paths: required: false schema: type: string - - &727 + - &728 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 @@ -54120,10 +54171,10 @@ paths: required: false schema: type: string - - *420 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -54131,9 +54182,9 @@ paths: application/json: schema: type: array - items: *424 + items: *425 examples: - default: *425 + default: *426 headers: Link: *43 '404': *6 @@ -54168,9 +54219,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *427 examples: - default: *427 + default: *428 '403': *29 '404': *6 patch: @@ -54323,7 +54374,7 @@ paths: application/json: schema: type: array - items: &748 + items: &749 description: A repository security advisory. type: object properties: @@ -54543,7 +54594,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 credits_detailed: type: array nullable: true @@ -54553,7 +54604,7 @@ paths: type: object properties: user: *4 - type: *428 + type: *429 state: type: string description: The state of the user's acceptance of the @@ -54614,7 +54665,7 @@ paths: - private_fork additionalProperties: false examples: - default: &749 + default: &750 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55001,7 +55052,7 @@ paths: application/json: schema: type: array - items: *429 + items: *430 examples: default: *375 x-github: @@ -55085,7 +55136,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *83 - - *430 + - *431 - *17 - *19 responses: @@ -55093,9 +55144,9 @@ paths: description: Success content: application/json: - schema: *431 + schema: *432 examples: - default: *432 + default: *433 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55376,7 +55427,7 @@ paths: type: array items: *143 examples: - default: *433 + default: *434 headers: Link: *43 x-github: @@ -55577,15 +55628,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: - *83 - - *434 + - *435 responses: '200': description: Response content: application/json: - schema: *435 + schema: *436 examples: - default: *436 + default: *437 headers: Link: *43 x-github: @@ -55623,7 +55674,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &459 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55669,7 +55720,7 @@ paths: type: string nullable: true examples: - default: &459 + default: &460 value: groups: - group_id: '123' @@ -55877,7 +55928,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &438 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56204,7 +56255,7 @@ paths: - repos_count - organization examples: - default: &438 + default: &439 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56281,9 +56332,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -56367,16 +56418,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -56446,7 +56497,7 @@ paths: application/json: schema: type: array - items: &439 + items: &440 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56545,7 +56596,7 @@ paths: - updated_at - url examples: - default: &792 + default: &793 value: - author: login: octocat @@ -56654,9 +56705,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &440 + default: &441 value: author: login: octocat @@ -56730,7 +56781,7 @@ paths: parameters: - *83 - *210 - - &441 + - &442 name: discussion_number description: The number that identifies the discussion. in: path @@ -56742,9 +56793,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56768,7 +56819,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: false content: @@ -56791,9 +56842,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &793 + default: &794 value: author: login: octocat @@ -56865,7 +56916,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 responses: '204': description: Response @@ -56893,7 +56944,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - *106 - *17 - *19 @@ -56904,7 +56955,7 @@ paths: application/json: schema: type: array - items: &442 + items: &443 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56976,7 +57027,7 @@ paths: - updated_at - url examples: - default: &794 + default: &795 value: - author: login: octocat @@ -57046,7 +57097,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57068,9 +57119,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &443 + default: &444 value: author: login: octocat @@ -57138,8 +57189,8 @@ paths: parameters: - *83 - *210 - - *441 - - &444 + - *442 + - &445 name: comment_number description: The number that identifies the comment. in: path @@ -57151,9 +57202,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57177,8 +57228,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57200,9 +57251,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &795 + default: &796 value: author: login: octocat @@ -57268,8 +57319,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 responses: '204': description: Response @@ -57297,8 +57348,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 - 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. @@ -57324,7 +57375,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57367,7 +57418,7 @@ paths: - content - created_at examples: - default: &447 + default: &448 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57419,8 +57470,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57453,9 +57504,9 @@ paths: team discussion comment content: application/json: - schema: *445 + schema: *446 examples: - default: &446 + default: &447 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57484,9 +57535,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57511,9 +57562,9 @@ paths: parameters: - *83 - *210 - - *441 - - *444 - - &448 + - *442 + - *445 + - &449 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57547,7 +57598,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - 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. @@ -57573,9 +57624,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -57603,7 +57654,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57635,16 +57686,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57669,8 +57720,8 @@ paths: parameters: - *83 - *210 - - *441 - - *448 + - *442 + - *449 responses: '204': description: Response @@ -57700,9 +57751,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *450 + default: *451 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57745,9 +57796,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57888,7 +57939,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &454 title: Team Membership description: Team Membership type: object @@ -57915,7 +57966,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &796 + response-if-user-is-a-team-maintainer: &797 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57978,9 +58029,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: &797 + response-if-users-membership-with-team-is-now-pending: &798 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -58053,7 +58104,7 @@ paths: application/json: schema: type: array - items: &454 + items: &455 title: Team Project description: A team's access to a project. type: object @@ -58121,7 +58172,7 @@ paths: - updated_at - permissions examples: - default: &798 + default: &799 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -58186,7 +58237,7 @@ paths: parameters: - *83 - *210 - - &455 + - &456 name: project_id description: The unique identifier of the project. in: path @@ -58198,9 +58249,9 @@ paths: description: Response content: application/json: - schema: *454 + schema: *455 examples: - default: &799 + default: &800 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -58264,7 +58315,7 @@ paths: parameters: - *83 - *210 - - *455 + - *456 requestBody: required: false content: @@ -58332,7 +58383,7 @@ paths: parameters: - *83 - *210 - - *455 + - *456 responses: '204': description: Response @@ -58403,14 +58454,14 @@ paths: parameters: - *83 - *210 - - *456 - *457 + - *458 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &800 + schema: &801 title: Team Repository description: A team's access to a repository. type: object @@ -58981,8 +59032,8 @@ paths: parameters: - *83 - *210 - - *456 - *457 + - *458 requestBody: required: false content: @@ -59029,8 +59080,8 @@ paths: parameters: - *83 - *210 - - *456 - *457 + - *458 responses: '204': description: Response @@ -59063,9 +59114,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *459 examples: - default: *459 + default: *460 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59131,7 +59182,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *459 examples: default: value: @@ -59176,7 +59227,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: &801 + response-if-child-teams-exist: &802 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -59303,7 +59354,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &460 + - &461 name: card_id description: The unique identifier of the card. in: path @@ -59315,7 +59366,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &462 title: Project Card description: Project cards represent a scope of work. type: object @@ -59382,7 +59433,7 @@ paths: - created_at - updated_at examples: - default: &462 + default: &463 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -59438,7 +59489,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *460 + - *461 requestBody: required: false content: @@ -59465,9 +59516,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *462 + default: *463 '304': *37 '403': *29 '401': *25 @@ -59494,7 +59545,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *460 + - *461 responses: '204': description: Response @@ -59538,7 +59589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *460 + - *461 requestBody: required: true content: @@ -59649,7 +59700,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &463 + - &464 name: column_id description: The unique identifier of the column. in: path @@ -59661,7 +59712,7 @@ paths: description: Response content: application/json: - schema: &464 + schema: &465 title: Project Column description: Project columns contain cards of work. type: object @@ -59707,7 +59758,7 @@ paths: - created_at - updated_at examples: - default: &465 + default: &466 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -59742,7 +59793,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *463 + - *464 requestBody: required: true content: @@ -59766,9 +59817,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - default: *465 + default: *466 '304': *37 '403': *29 '401': *25 @@ -59793,7 +59844,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *463 + - *464 responses: '204': description: Response @@ -59822,7 +59873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *463 + - *464 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -59843,7 +59894,7 @@ paths: application/json: schema: type: array - items: *461 + items: *462 examples: default: value: @@ -59902,7 +59953,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *463 + - *464 requestBody: required: true content: @@ -59942,9 +59993,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *462 + default: *463 '304': *37 '403': *29 '401': *25 @@ -60000,7 +60051,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *463 + - *464 requestBody: required: true content: @@ -60060,7 +60111,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *455 + - *456 - 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 @@ -60117,7 +60168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *455 + - *456 - *138 requestBody: required: false @@ -60170,7 +60221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *455 + - *456 - *138 responses: '204': @@ -60202,7 +60253,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: - - *455 + - *456 - *138 responses: '200': @@ -60303,7 +60354,7 @@ paths: resources: type: object properties: - core: &466 + core: &467 title: Rate Limit type: object properties: @@ -60320,21 +60371,21 @@ paths: - remaining - reset - used - graphql: *466 - search: *466 - code_search: *466 - source_import: *466 - integration_manifest: *466 - code_scanning_upload: *466 - actions_runner_registration: *466 - scim: *466 - dependency_snapshots: *466 - dependency_sbom: *466 - code_scanning_autofix: *466 + graphql: *467 + search: *467 + code_search: *467 + source_import: *467 + integration_manifest: *467 + code_scanning_upload: *467 + actions_runner_registration: *467 + scim: *467 + dependency_snapshots: *467 + dependency_sbom: *467 + code_scanning_autofix: *467 required: - core - search - rate: *466 + rate: *467 required: - rate - resources @@ -60439,14 +60490,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: default-response: summary: Default response @@ -60951,7 +61002,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *468 + '301': *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60969,8 +61020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -61227,10 +61278,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 - '307': &470 + default: *470 + '307': &471 description: Temporary Redirect content: application/json: @@ -61259,8 +61310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -61282,7 +61333,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': *470 + '307': *471 '404': *6 '409': *114 x-github: @@ -61306,11 +61357,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 - - &485 + - &486 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61333,7 +61384,7 @@ paths: type: integer artifacts: type: array - items: &471 + items: &472 title: Artifact description: An artifact type: object @@ -61411,7 +61462,7 @@ paths: - expires_at - updated_at examples: - default: &486 + default: &487 value: total_count: 2 artifacts: @@ -61472,9 +61523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *456 - *457 - - &472 + - *458 + - &473 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61486,7 +61537,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *472 examples: default: value: @@ -61524,9 +61575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *456 - *457 - - *472 + - *458 + - *473 responses: '204': description: Response @@ -61550,9 +61601,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *456 - *457 - - *472 + - *458 + - *473 - name: archive_format in: path required: true @@ -61566,7 +61617,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': &647 + '410': &648 description: Gone content: application/json: @@ -61593,14 +61644,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: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *473 + schema: *474 examples: default: value: @@ -61626,11 +61677,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: - - *456 - *457 + - *458 - *17 - *19 - - &474 + - &475 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 @@ -61664,7 +61715,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &476 title: Repository actions caches description: Repository actions caches type: object @@ -61706,7 +61757,7 @@ paths: - total_count - actions_caches examples: - default: &476 + default: &477 value: total_count: 1 actions_caches: @@ -61738,23 +61789,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: - - *456 - *457 + - *458 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *475 + schema: *476 examples: - default: *476 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61774,8 +61825,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: - - *456 - *457 + - *458 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61806,9 +61857,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: - - *456 - *457 - - &477 + - *458 + - &478 name: job_id description: The unique identifier of the job. in: path @@ -61820,7 +61871,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &490 title: Job description: Information of a job execution in a workflow run type: object @@ -62127,9 +62178,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: - - *456 - *457 - - *477 + - *458 + - *478 responses: '302': description: Response @@ -62157,9 +62208,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: - - *456 - *457 - - *477 + - *458 + - *478 requestBody: required: false content: @@ -62204,8 +62255,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: - - *456 - *457 + - *458 responses: '200': description: Status response @@ -62255,8 +62306,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -62319,8 +62370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -62338,7 +62389,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &492 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62358,7 +62409,7 @@ paths: - created_at - updated_at examples: - default: &492 + default: &493 value: total_count: 2 secrets: @@ -62391,9 +62442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *456 - *457 - - *478 + - *458 + - *479 - *19 responses: '200': @@ -62410,7 +62461,7 @@ paths: type: integer variables: type: array - items: &495 + items: &496 title: Actions Variable type: object properties: @@ -62440,7 +62491,7 @@ paths: - created_at - updated_at examples: - default: &496 + default: &497 value: total_count: 2 variables: @@ -62473,8 +62524,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62483,7 +62534,7 @@ paths: schema: type: object properties: - enabled: &479 + enabled: &480 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *56 @@ -62518,8 +62569,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -62530,7 +62581,7 @@ paths: schema: type: object properties: - enabled: *479 + enabled: *480 allowed_actions: *56 sha_pinning_required: *57 required: @@ -62563,14 +62614,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: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: &480 + schema: &481 type: object properties: access_level: @@ -62588,7 +62639,7 @@ paths: required: - access_level examples: - default: &481 + default: &482 value: access_level: organization x-github: @@ -62613,15 +62664,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: - - *456 - *457 + - *458 requestBody: required: true content: application/json: - schema: *480 + schema: *481 examples: - default: *481 + default: *482 responses: '204': description: Response @@ -62645,8 +62696,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62676,8 +62727,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: - - *456 - *457 + - *458 responses: '204': description: Empty response for successful settings update @@ -62711,8 +62762,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62739,8 +62790,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -62774,8 +62825,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62803,8 +62854,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -62835,8 +62886,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62867,8 +62918,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -62900,8 +62951,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62930,8 +62981,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: - - *456 - *457 + - *458 responses: '204': description: Success response @@ -62971,8 +63022,8 @@ paths: in: query schema: type: string - - *456 - *457 + - *458 - *17 - *19 responses: @@ -63016,8 +63067,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -63049,8 +63100,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -63124,8 +63175,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: - - *456 - *457 + - *458 responses: '201': description: Response @@ -63161,8 +63212,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: - - *456 - *457 + - *458 responses: '201': description: Response @@ -63192,8 +63243,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: - - *456 - *457 + - *458 - *71 responses: '200': @@ -63223,8 +63274,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: - - *456 - *457 + - *458 - *71 responses: '204': @@ -63251,8 +63302,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: - - *456 - *457 + - *458 - *71 responses: '200': *77 @@ -63277,8 +63328,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: - - *456 - *457 + - *458 - *71 requestBody: required: true @@ -63327,8 +63378,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: - - *456 - *457 + - *458 - *71 requestBody: required: true @@ -63378,8 +63429,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: - - *456 - *457 + - *458 - *71 responses: '200': *281 @@ -63409,8 +63460,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: - - *456 - *457 + - *458 - *71 - *282 responses: @@ -63440,9 +63491,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: - - *456 - *457 - - &499 + - *458 + - &500 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. @@ -63450,7 +63501,7 @@ paths: required: false schema: type: string - - &500 + - &501 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63458,7 +63509,7 @@ paths: required: false schema: type: string - - &501 + - &502 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63467,7 +63518,7 @@ paths: required: false schema: type: string - - &502 + - &503 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 @@ -63494,7 +63545,7 @@ paths: - pending - *17 - *19 - - &503 + - &504 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)." @@ -63503,7 +63554,7 @@ paths: schema: type: string format: date-time - - &482 + - &483 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63512,13 +63563,13 @@ paths: schema: type: boolean default: false - - &504 + - &505 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &505 + - &506 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63541,7 +63592,7 @@ paths: type: integer workflow_runs: type: array - items: &483 + items: &484 title: Workflow Run description: An invocation of a workflow type: object @@ -63636,7 +63687,7 @@ paths: that triggered the run. type: array nullable: true - items: &524 + items: &525 title: Pull Request Minimal type: object properties: @@ -63755,7 +63806,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &528 + properties: &529 id: type: string description: SHA for the commit @@ -63806,7 +63857,7 @@ paths: - name - email nullable: true - required: &529 + required: &530 - id - tree_id - message @@ -63853,7 +63904,7 @@ paths: - workflow_url - pull_requests examples: - default: &506 + default: &507 value: total_count: 1 workflow_runs: @@ -64089,24 +64140,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *456 - *457 - - &484 + - *458 + - &485 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *482 + - *483 responses: '200': description: Response content: application/json: - schema: *483 + schema: *484 examples: - default: &487 + default: &488 value: id: 30433642 name: Build @@ -64347,9 +64398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '204': description: Response @@ -64372,9 +64423,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: - - *456 - *457 - - *484 + - *458 + - *485 responses: '200': description: Response @@ -64493,9 +64544,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: - - *456 - *457 - - *484 + - *458 + - *485 responses: '201': description: Response @@ -64528,12 +64579,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *456 - *457 - - *484 + - *458 + - *485 - *17 - *19 - - *485 + - *486 responses: '200': description: Response @@ -64549,9 +64600,9 @@ paths: type: integer artifacts: type: array - items: *471 + items: *472 examples: - default: *486 + default: *487 headers: Link: *43 x-github: @@ -64575,25 +64626,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *456 - *457 - - *484 - - &488 + - *458 + - *485 + - &489 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *482 + - *483 responses: '200': description: Response content: application/json: - schema: *483 + schema: *484 examples: - default: *487 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64616,10 +64667,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: - - *456 - *457 - - *484 - - *488 + - *458 + - *485 + - *489 - *17 - *19 responses: @@ -64637,9 +64688,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *490 examples: - default: &490 + default: &491 value: total_count: 1 jobs: @@ -64752,10 +64803,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *456 - *457 - - *484 - - *488 + - *458 + - *485 + - *489 responses: '302': description: Response @@ -64783,9 +64834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '202': description: Response @@ -64818,9 +64869,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: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: true content: @@ -64887,9 +64938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '202': description: Response @@ -64922,9 +64973,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: - - *456 - *457 - - *484 + - *458 + - *485 - 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 @@ -64954,9 +65005,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *490 examples: - default: *490 + default: *491 headers: Link: *43 x-github: @@ -64981,9 +65032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '302': description: Response @@ -65010,9 +65061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '204': description: Response @@ -65039,9 +65090,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: - - *456 - *457 - - *484 + - *458 + - *485 responses: '200': description: Response @@ -65101,7 +65152,7 @@ paths: items: type: object properties: - type: &613 + type: &614 type: string description: The type of reviewer. enum: @@ -65186,9 +65237,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: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: true content: @@ -65235,7 +65286,7 @@ paths: application/json: schema: type: array - items: &599 + items: &600 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65341,7 +65392,7 @@ paths: - created_at - updated_at examples: - default: &600 + default: &601 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65397,9 +65448,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: false content: @@ -65443,9 +65494,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: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: false content: @@ -65499,9 +65550,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '200': description: Response @@ -65638,8 +65689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -65657,9 +65708,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *492 examples: - default: *492 + default: *493 headers: Link: *43 x-github: @@ -65684,16 +65735,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *493 + schema: *494 examples: - default: *494 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65715,17 +65766,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *492 examples: - default: &626 + default: &627 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65751,8 +65802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 requestBody: required: true @@ -65810,8 +65861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '204': @@ -65837,9 +65888,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *456 - *457 - - *478 + - *458 + - *479 - *19 responses: '200': @@ -65856,9 +65907,9 @@ paths: type: integer variables: type: array - items: *495 + items: *496 examples: - default: *496 + default: *497 headers: Link: *43 x-github: @@ -65881,8 +65932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -65934,17 +65985,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *456 - *457 + - *458 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: &627 + default: &628 value: name: USERNAME value: octocat @@ -65970,8 +66021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *456 - *457 + - *458 - *287 requestBody: required: true @@ -66014,8 +66065,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *456 - *457 + - *458 - *287 responses: '204': @@ -66041,8 +66092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -66060,7 +66111,7 @@ paths: type: integer workflows: type: array - items: &497 + items: &498 title: Workflow description: A GitHub Actions workflow type: object @@ -66167,9 +66218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *456 - *457 - - &498 + - *458 + - &499 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66184,7 +66235,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *498 examples: default: value: @@ -66217,9 +66268,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '204': description: Response @@ -66244,9 +66295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '204': description: Response @@ -66297,9 +66348,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '204': description: Response @@ -66326,19 +66377,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: - - *456 - *457 - - *498 + - *458 - *499 - *500 - *501 - *502 + - *503 - *17 - *19 - - *503 - - *482 - *504 + - *483 - *505 + - *506 responses: '200': description: Response @@ -66354,9 +66405,9 @@ paths: type: integer workflow_runs: type: array - items: *483 + items: *484 examples: - default: *506 + default: *507 headers: Link: *43 x-github: @@ -66389,9 +66440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '200': description: Response @@ -66452,8 +66503,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *456 - *457 + - *458 - *106 - *17 - *104 @@ -66617,8 +66668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -66655,8 +66706,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: - - *456 - *457 + - *458 - name: assignee in: path required: true @@ -66692,8 +66743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -66805,8 +66856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *456 - *457 + - *458 - *17 - *104 - *105 @@ -66863,7 +66914,7 @@ paths: initiator: type: string examples: - default: *507 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66883,8 +66934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -66892,7 +66943,7 @@ paths: application/json: schema: type: array - items: &508 + items: &509 title: Autolink reference description: An autolink reference. type: object @@ -66946,8 +66997,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -66986,9 +67037,9 @@ paths: description: response content: application/json: - schema: *508 + schema: *509 examples: - default: &509 + default: &510 value: id: 1 key_prefix: TICKET- @@ -67019,9 +67070,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: - - *456 - *457 - - &510 + - *458 + - &511 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67033,9 +67084,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *509 examples: - default: *509 + default: *510 '404': *6 x-github: githubCloudOnly: false @@ -67055,9 +67106,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: - - *456 - *457 - - *510 + - *458 + - *511 responses: '204': description: Response @@ -67081,8 +67132,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: - - *456 - *457 + - *458 responses: '200': description: Response if Dependabot is enabled @@ -67130,8 +67181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -67152,8 +67203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -67173,8 +67224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *456 - *457 + - *458 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67212,7 +67263,7 @@ paths: - url protected: type: boolean - protection: &512 + protection: &513 title: Branch Protection description: Branch Protection type: object @@ -67254,7 +67305,7 @@ paths: required: - contexts - checks - enforce_admins: &515 + enforce_admins: &516 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67269,7 +67320,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &517 + required_pull_request_reviews: &518 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67345,7 +67396,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &514 + restrictions: &515 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67622,9 +67673,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *456 - *457 - - &513 + - *458 + - &514 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). @@ -67638,14 +67689,14 @@ paths: description: Response content: application/json: - schema: &523 + schema: &524 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &573 + commit: &574 title: Commit description: Commit type: object @@ -67679,7 +67730,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &511 + properties: &512 name: type: string example: '"Chris Wanstrath"' @@ -67688,13 +67739,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *512 nullable: true message: type: string @@ -67715,7 +67767,7 @@ paths: required: - sha - url - verification: &633 + verification: &634 title: Verification type: object properties: @@ -67785,7 +67837,7 @@ paths: type: integer files: type: array - items: &586 + items: &587 title: Diff Entry description: Diff Entry type: object @@ -67869,7 +67921,7 @@ paths: - self protected: type: boolean - protection: *512 + protection: *513 protection_url: type: string format: uri @@ -67976,7 +68028,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *468 + '301': *469 '404': *6 x-github: githubCloudOnly: false @@ -67998,15 +68050,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *512 + schema: *513 examples: default: value: @@ -68200,9 +68252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -68457,7 +68509,7 @@ paths: url: type: string format: uri - required_status_checks: &520 + required_status_checks: &521 title: Status Check Policy description: Status Check Policy type: object @@ -68609,7 +68661,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *514 + restrictions: *515 required_conversation_resolution: type: object properties: @@ -68721,9 +68773,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -68748,17 +68800,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: &516 + default: &517 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68780,17 +68832,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: *516 + default: *517 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68809,9 +68861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -68836,17 +68888,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: &518 + default: &519 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68942,9 +68994,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69042,9 +69094,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: *518 + default: *519 '422': *15 x-github: githubCloudOnly: false @@ -69065,9 +69117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69094,17 +69146,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: &519 + default: &520 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69127,17 +69179,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: *519 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -69157,9 +69209,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69184,17 +69236,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69220,9 +69272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69274,9 +69326,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 '404': *6 '422': *15 x-github: @@ -69298,9 +69350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69324,9 +69376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -69360,9 +69412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69429,9 +69481,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69495,9 +69547,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: content: application/json: @@ -69563,15 +69615,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *514 + schema: *515 examples: default: value: @@ -69662,9 +69714,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69687,9 +69739,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: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -69699,7 +69751,7 @@ paths: type: array items: *5 examples: - default: &522 + default: &523 value: - id: 1 slug: octoapp @@ -69756,9 +69808,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -69792,7 +69844,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -69813,9 +69865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -69849,7 +69901,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -69870,9 +69922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -69906,7 +69958,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -69928,9 +69980,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: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -69960,9 +70012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -70021,9 +70073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -70082,9 +70134,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: content: application/json: @@ -70143,9 +70195,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: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -70179,9 +70231,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70239,9 +70291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70299,9 +70351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70361,9 +70413,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70385,7 +70437,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *524 examples: default: value: @@ -70499,8 +70551,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - *457 + - *458 - *99 - *100 - *101 @@ -70536,8 +70588,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - *457 + - *458 - name: bypass_request_number in: path required: true @@ -70610,8 +70662,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - *99 - *100 - *101 @@ -70651,8 +70703,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - name: bypass_request_number in: path required: true @@ -70722,8 +70774,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - name: bypass_request_number in: path required: true @@ -70794,8 +70846,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - name: bypass_response_id in: path required: true @@ -70828,8 +70880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -71108,7 +71160,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &526 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71227,8 +71279,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *524 - deployment: &851 + items: *525 + deployment: &852 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71508,9 +71560,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *456 - *457 - - &526 + - *458 + - &527 name: check_run_id description: The unique identifier of the check run. in: path @@ -71522,9 +71574,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: &527 + default: &528 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71624,9 +71676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *456 - *457 - - *526 + - *458 + - *527 requestBody: required: true content: @@ -71866,9 +71918,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: *527 + default: *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71888,9 +71940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *456 - *457 - - *526 + - *458 + - *527 - *17 - *19 responses: @@ -71985,9 +72037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *456 - *457 - - *526 + - *458 + - *527 responses: '201': description: Response @@ -72031,8 +72083,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -72054,7 +72106,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &530 + schema: &531 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72118,7 +72170,7 @@ paths: nullable: true pull_requests: type: array - items: *524 + items: *525 nullable: true app: title: GitHub app @@ -72140,12 +72192,12 @@ paths: type: string format: date-time nullable: true - head_commit: &882 + head_commit: &883 title: Simple Commit description: A commit. type: object - properties: *528 - required: *529 + properties: *529 + required: *530 latest_check_runs_count: type: integer check_runs_url: @@ -72173,7 +72225,7 @@ paths: - check_runs_url - pull_requests examples: - default: &531 + default: &532 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72464,9 +72516,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *530 + schema: *531 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72485,8 +72537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -72795,9 +72847,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *456 - *457 - - &532 + - *458 + - &533 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72809,9 +72861,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *531 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,17 +72886,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: - - *456 - *457 - - *532 - - &579 + - *458 + - *533 + - &580 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &580 + - &581 name: status description: Returns check runs with the specified `status`. in: query @@ -72883,9 +72935,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *526 examples: - default: &581 + default: &582 value: total_count: 1 check_runs: @@ -72987,9 +73039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *456 - *457 - - *532 + - *458 + - *533 responses: '201': description: Response @@ -73022,21 +73074,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: - - *456 - *457 + - *458 - *307 - *308 - *19 - *17 - - &548 + - &549 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: *533 - - &549 + schema: *534 + - &550 name: pr description: The number of the pull request for the results you want to list. in: query @@ -73067,7 +73119,7 @@ paths: be returned. in: query required: false - schema: *534 + schema: *535 responses: '200': description: Response @@ -73083,7 +73135,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *536 state: *109 fixed_at: *133 dismissed_by: @@ -73094,11 +73146,11 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 - rule: *538 - tool: *539 - most_recent_instance: *540 + dismissed_reason: *537 + dismissed_comment: *538 + rule: *539 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73224,7 +73276,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &541 + '403': &542 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -73251,9 +73303,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: - - *456 - *457 - - &542 + - *458 + - &543 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73267,7 +73319,7 @@ paths: description: Response content: application/json: - schema: &543 + schema: &544 type: object properties: number: *123 @@ -73275,7 +73327,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *536 state: *109 fixed_at: *133 dismissed_by: @@ -73286,8 +73338,8 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *537 + dismissed_comment: *538 rule: type: object properties: @@ -73341,8 +73393,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *539 - most_recent_instance: *540 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73441,7 +73493,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -73461,9 +73513,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: - - *456 - *457 - - *542 + - *458 + - *543 requestBody: required: true content: @@ -73478,8 +73530,8 @@ paths: enum: - open - dismissed - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *537 + dismissed_comment: *538 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73498,7 +73550,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *544 examples: default: value: @@ -73574,7 +73626,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &547 + '403': &548 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -73601,15 +73653,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: - - *456 - *457 - - *542 + - *458 + - *543 responses: '200': description: Response content: application/json: - schema: &544 + schema: &545 type: object properties: status: @@ -73635,13 +73687,13 @@ paths: - description - started_at examples: - default: &545 + default: &546 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &546 + '400': &547 description: Bad Request content: application/json: @@ -73652,7 +73704,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': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -73677,29 +73729,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: - - *456 - *457 - - *542 + - *458 + - *543 responses: '200': description: OK content: application/json: - schema: *544 + schema: *545 examples: - default: *545 + default: *546 '202': description: Accepted content: application/json: - schema: *544 + schema: *545 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *546 + '400': *547 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73731,9 +73783,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: - - *456 - *457 - - *542 + - *458 + - *543 requestBody: required: false content: @@ -73778,8 +73830,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *546 - '403': *547 + '400': *547 + '403': *548 '404': *6 '422': description: Unprocessable Entity @@ -73803,13 +73855,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: - - *456 - *457 - - *542 + - *458 + - *543 - *19 - *17 - - *548 - *549 + - *550 responses: '200': description: Response @@ -73817,7 +73869,7 @@ paths: application/json: schema: type: array - items: *540 + items: *541 examples: default: value: @@ -73856,7 +73908,7 @@ paths: end_column: 50 classifications: - source - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -73890,25 +73942,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: - - *456 - *457 + - *458 - *307 - *308 - *19 - *17 - - *549 + - *550 - 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: *533 + schema: *534 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &552 + schema: &553 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -73929,23 +73981,23 @@ paths: application/json: schema: type: array - items: &553 + items: &554 type: object properties: - ref: *533 - commit_sha: &561 + ref: *534 + commit_sha: &562 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: *550 + analysis_key: *551 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *552 error: type: string example: error reading field xyz @@ -73969,8 +74021,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *552 - tool: *539 + sarif_id: *553 + tool: *540 deletable: type: boolean warning: @@ -74031,7 +74083,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -74067,8 +74119,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: - - *456 - *457 + - *458 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74081,7 +74133,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *554 examples: response: summary: application/json response @@ -74135,7 +74187,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *541 + '403': *542 '404': *6 '422': description: Response if analysis could not be processed @@ -74222,8 +74274,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: - - *456 - *457 + - *458 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74276,7 +74328,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': *547 + '403': *548 '404': *6 '503': *190 x-github: @@ -74298,8 +74350,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -74307,7 +74359,7 @@ paths: application/json: schema: type: array - items: &554 + items: &555 title: CodeQL Database description: A CodeQL database. type: object @@ -74418,7 +74470,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': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -74447,8 +74499,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: - - *456 - *457 + - *458 - name: language in: path description: The language of the CodeQL database. @@ -74460,7 +74512,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *555 examples: default: value: @@ -74492,9 +74544,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': &588 + '302': &589 description: Found - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -74516,8 +74568,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *456 - *457 + - *458 - name: language in: path description: The language of the CodeQL database. @@ -74527,7 +74579,7 @@ paths: responses: '204': description: Response - '403': *547 + '403': *548 '404': *6 '503': *190 x-github: @@ -74555,8 +74607,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -74565,7 +74617,7 @@ paths: type: object additionalProperties: false properties: - language: &555 + language: &556 type: string description: The language targeted by the CodeQL query enum: @@ -74645,7 +74697,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &559 + schema: &560 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74655,7 +74707,7 @@ paths: description: The ID of the variant analysis. controller_repo: *115 actor: *4 - query_language: *555 + query_language: *556 query_pack_url: type: string description: The download url for the query pack. @@ -74702,7 +74754,7 @@ paths: items: type: object properties: - repository: &556 + repository: &557 title: Repository Identifier description: Repository Identifier type: object @@ -74738,7 +74790,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &560 + analysis_status: &561 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74770,7 +74822,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &557 + access_mismatch_repos: &558 type: object properties: repository_count: @@ -74784,7 +74836,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: *556 + items: *557 required: - repository_count - repositories @@ -74806,8 +74858,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *557 - over_limit_repos: *557 + no_codeql_db_repos: *558 + over_limit_repos: *558 required: - access_mismatch_repos - not_found_repos @@ -74823,7 +74875,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &558 + value: &559 summary: Default response value: id: 1 @@ -74975,10 +75027,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *558 + value: *559 repository_lists: summary: Response for a successful variant analysis submission - value: *558 + value: *559 '404': *6 '422': description: Unable to process variant analysis submission @@ -75006,8 +75058,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: - - *456 - *457 + - *458 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75019,9 +75071,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: - default: *558 + default: *559 '404': *6 '503': *190 x-github: @@ -75044,7 +75096,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: - - *456 + - *457 - name: repo in: path description: The name of the controller repository. @@ -75079,7 +75131,7 @@ paths: type: object properties: repository: *115 - analysis_status: *560 + analysis_status: *561 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75204,8 +75256,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -75290,7 +75342,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -75311,8 +75363,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -75404,7 +75456,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *547 + '403': *548 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75475,8 +75527,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -75484,7 +75536,7 @@ paths: schema: type: object properties: - commit_sha: *561 + commit_sha: *562 ref: type: string description: |- @@ -75542,7 +75594,7 @@ paths: schema: type: object properties: - id: *552 + id: *553 url: type: string description: The REST API URL for checking the status of the upload. @@ -75556,7 +75608,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': *547 + '403': *548 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -75579,8 +75631,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: - - *456 - *457 + - *458 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75626,7 +75678,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': *541 + '403': *542 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -75651,8 +75703,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -75733,8 +75785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *456 - *457 + - *458 - 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 @@ -75854,8 +75906,8 @@ paths: parameters: - *17 - *19 - - *456 - *457 + - *458 responses: '200': description: Response @@ -76169,8 +76221,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -76235,7 +76287,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -76243,7 +76295,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '400': *14 '401': *25 '403': *29 @@ -76272,8 +76324,8 @@ paths: parameters: - *17 - *19 - - *456 - *457 + - *458 responses: '200': description: Response @@ -76337,8 +76389,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: - - *456 - *457 + - *458 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76373,14 +76425,14 @@ paths: type: integer machines: type: array - items: &808 + items: &809 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *564 + required: *565 examples: - default: &809 + default: &810 value: total_count: 2 machines: @@ -76420,8 +76472,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *456 - *457 + - *458 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76505,8 +76557,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: - - *456 - *457 + - *458 - 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 @@ -76572,8 +76624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -76591,7 +76643,7 @@ paths: type: integer secrets: type: array - items: &568 + items: &569 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76611,7 +76663,7 @@ paths: - created_at - updated_at examples: - default: *565 + default: *566 headers: Link: *43 x-github: @@ -76634,16 +76686,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: *567 + default: *568 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76663,17 +76715,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '200': description: Response content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76693,8 +76745,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: - - *456 - *457 + - *458 - *284 requestBody: required: true @@ -76747,8 +76799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '204': @@ -76777,8 +76829,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *456 - *457 + - *458 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76820,7 +76872,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &570 + properties: &571 login: type: string example: octocat @@ -76913,7 +76965,7 @@ paths: user_view_type: type: string example: public - required: &571 + required: &572 - avatar_url - events_url - followers_url @@ -76987,8 +77039,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: - - *456 - *457 + - *458 - *138 responses: '204': @@ -77035,8 +77087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *456 - *457 + - *458 - *138 requestBody: required: false @@ -77063,7 +77115,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &646 + schema: &647 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77292,8 +77344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *456 - *457 + - *458 - *138 responses: '204': @@ -77325,8 +77377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *456 - *457 + - *458 - *138 responses: '200': @@ -77347,8 +77399,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *570 - required: *571 + properties: *571 + required: *572 nullable: true required: - permission @@ -77403,8 +77455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -77414,7 +77466,7 @@ paths: application/json: schema: type: array - items: &572 + items: &573 title: Commit Comment description: Commit Comment type: object @@ -77472,7 +77524,7 @@ paths: - created_at - updated_at examples: - default: &575 + default: &576 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77531,17 +77583,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 responses: '200': description: Response content: application/json: - schema: *572 + schema: *573 examples: - default: &576 + default: &577 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77598,8 +77650,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -77622,7 +77674,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: default: value: @@ -77673,8 +77725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 responses: '204': @@ -77696,8 +77748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -77724,9 +77776,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -77747,8 +77799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -77781,16 +77833,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -77812,10 +77864,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *456 - *457 + - *458 - *226 - - *448 + - *449 responses: '204': description: Response @@ -77864,8 +77916,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *456 - *457 + - *458 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77921,9 +77973,9 @@ paths: application/json: schema: type: array - items: *573 + items: *574 examples: - default: &699 + default: &700 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78017,9 +78069,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *456 - *457 - - &574 + - *458 + - &575 name: commit_sha description: The SHA of the commit. in: path @@ -78091,9 +78143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *456 - *457 - - *574 + - *458 + - *575 - *17 - *19 responses: @@ -78103,9 +78155,9 @@ paths: application/json: schema: type: array - items: *572 + items: *573 examples: - default: *575 + default: *576 headers: Link: *43 x-github: @@ -78133,9 +78185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *456 - *457 - - *574 + - *458 + - *575 requestBody: required: true content: @@ -78170,9 +78222,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: - default: *576 + default: *577 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78200,9 +78252,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: - - *456 - *457 - - *574 + - *458 + - *575 - *17 - *19 responses: @@ -78212,9 +78264,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: &691 + default: &692 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78751,11 +78803,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *456 - *457 + - *458 - *19 - *17 - - &578 + - &579 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)" @@ -78770,9 +78822,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &676 + default: &677 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78885,11 +78937,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: - - *456 - *457 - - *578 + - *458 - *579 - *580 + - *581 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78923,9 +78975,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *526 examples: - default: *581 + default: *582 headers: Link: *43 x-github: @@ -78950,9 +79002,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: - - *456 - *457 - - *578 + - *458 + - *579 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78960,7 +79012,7 @@ paths: schema: type: integer example: 1 - - *579 + - *580 - *17 - *19 responses: @@ -78978,7 +79030,7 @@ paths: type: integer check_suites: type: array - items: *530 + items: *531 examples: default: value: @@ -79178,9 +79230,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: - - *456 - *457 - - *578 + - *458 + - *579 - *17 - *19 responses: @@ -79378,9 +79430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *456 - *457 - - *578 + - *458 + - *579 - *17 - *19 responses: @@ -79390,7 +79442,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 title: Status description: The status of a commit. type: object @@ -79471,7 +79523,7 @@ paths: site_admin: false headers: Link: *43 - '301': *468 + '301': *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79499,8 +79551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -79529,20 +79581,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *582 - required: *583 + properties: *583 + required: *584 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &584 + properties: &585 url: type: string format: uri html_url: type: string format: uri - required: &585 + required: &586 - url - html_url nullable: true @@ -79556,26 +79608,26 @@ paths: contributing: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true readme: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true issue_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true pull_request_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true required: - code_of_conduct @@ -79702,8 +79754,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *456 - *457 + - *458 - *19 - *17 - name: basehead @@ -79746,8 +79798,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *573 - merge_base_commit: *573 + base_commit: *574 + merge_base_commit: *574 status: type: string enum: @@ -79767,10 +79819,10 @@ paths: example: 6 commits: type: array - items: *573 + items: *574 files: type: array - items: *586 + items: *587 required: - url - html_url @@ -80056,8 +80108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *456 - *457 + - *458 - name: path description: path parameter in: path @@ -80200,7 +80252,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &587 + response-if-content-is-a-file: &588 summary: Response if content is a file value: type: file @@ -80332,7 +80384,7 @@ paths: - size - type - url - - &704 + - &705 title: Content File description: Content File type: object @@ -80533,7 +80585,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *587 + response-if-content-is-a-file: *588 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80602,7 +80654,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *588 + '302': *589 '304': *37 x-github: githubCloudOnly: false @@ -80625,8 +80677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *456 - *457 + - *458 - name: path description: path parameter in: path @@ -80719,7 +80771,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &590 title: File Commit description: File Commit type: object @@ -80871,7 +80923,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: example-for-creating-a-file: value: @@ -80925,7 +80977,7 @@ paths: schema: oneOf: - *3 - - &628 + - &629 description: Repository rule violation was detected type: object properties: @@ -80946,7 +80998,7 @@ paths: items: type: object properties: - placeholder_id: &745 + placeholder_id: &746 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80978,8 +81030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *456 - *457 + - *458 - name: path description: path parameter in: path @@ -81040,7 +81092,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -81095,8 +81147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *456 - *457 + - *458 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81219,8 +81271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *456 - *457 + - *458 - *323 - *324 - *325 @@ -81232,7 +81284,7 @@ paths: schema: type: string - *327 - - *590 + - *591 - *328 - *329 - *106 @@ -81253,7 +81305,7 @@ paths: application/json: schema: type: array - items: &593 + items: &594 type: object description: A Dependabot alert. properties: @@ -81299,7 +81351,7 @@ paths: - unknown - direct - transitive - security_advisory: *591 + security_advisory: *592 security_vulnerability: *127 url: *128 html_url: *129 @@ -81330,7 +81382,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: *592 + auto_dismissed_at: *593 required: - number - state @@ -81560,9 +81612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *456 - *457 - - &594 + - *458 + - &595 name: alert_number in: path description: |- @@ -81577,7 +81629,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: default: value: @@ -81690,9 +81742,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *456 - *457 - - *594 + - *458 + - *595 requestBody: required: true content: @@ -81737,7 +81789,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: default: value: @@ -81866,8 +81918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -81885,7 +81937,7 @@ paths: type: integer secrets: type: array - items: &597 + items: &598 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81938,16 +81990,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *595 + schema: *596 examples: - default: *596 + default: *597 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81967,15 +82019,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '200': description: Response content: application/json: - schema: *597 + schema: *598 examples: default: value: @@ -82001,8 +82053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 requestBody: required: true @@ -82055,8 +82107,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '204': @@ -82079,8 +82131,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: - - *456 - *457 + - *458 - 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 @@ -82240,8 +82292,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -82480,8 +82532,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -82556,7 +82608,7 @@ paths: - version - url additionalProperties: false - metadata: &598 + metadata: &599 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82589,7 +82641,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *598 + metadata: *599 resolved: type: object description: A collection of resolved package dependencies. @@ -82602,7 +82654,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *598 + metadata: *599 relationship: type: string description: A notation of whether a dependency is requested @@ -82731,8 +82783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *456 - *457 + - *458 - name: sha description: The SHA recorded at creation time. in: query @@ -82772,9 +82824,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *600 + default: *601 headers: Link: *43 x-github: @@ -82840,8 +82892,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -82922,7 +82974,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: simple-example: summary: Simple example @@ -82995,9 +83047,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *456 - *457 - - &601 + - *458 + - &602 name: deployment_id description: deployment_id parameter in: path @@ -83009,7 +83061,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: default: value: @@ -83074,9 +83126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *456 - *457 - - *601 + - *458 + - *602 responses: '204': description: Response @@ -83098,9 +83150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *456 - *457 - - *601 + - *458 + - *602 - *17 - *19 responses: @@ -83110,7 +83162,7 @@ paths: application/json: schema: type: array - items: &602 + items: &603 title: Deployment Status description: The status of a deployment. type: object @@ -83271,9 +83323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *456 - *457 - - *601 + - *458 + - *602 requestBody: required: true content: @@ -83348,9 +83400,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: &603 + default: &604 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83406,9 +83458,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *456 - *457 - - *601 + - *458 + - *602 - name: status_id in: path required: true @@ -83419,9 +83471,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *603 + default: *604 '404': *6 x-github: githubCloudOnly: false @@ -83448,12 +83500,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 - - *604 + - *458 - *605 - *606 - *607 + - *608 - *17 - *19 responses: @@ -83463,9 +83515,9 @@ paths: application/json: schema: type: array - items: *608 + items: *609 examples: - default: *609 + default: *610 '404': *6 '403': *29 '500': *40 @@ -83489,8 +83541,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83502,7 +83554,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *608 + schema: *609 examples: default: value: @@ -83558,8 +83610,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83618,12 +83670,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - *99 - *100 - *101 - - *610 + - *611 - *17 - *19 responses: @@ -83633,9 +83685,9 @@ paths: application/json: schema: type: array - items: *611 + items: *612 examples: - default: *612 + default: *613 '404': *6 '403': *29 '500': *40 @@ -83660,8 +83712,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83673,7 +83725,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *611 + schema: *612 examples: default: value: @@ -83731,8 +83783,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83801,8 +83853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -83859,8 +83911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -83877,7 +83929,7 @@ paths: type: integer environments: type: array - items: &614 + items: &615 title: Environment description: Details of a deployment environment type: object @@ -83929,7 +83981,7 @@ paths: type: type: string example: wait_timer - wait_timer: &616 + wait_timer: &617 type: integer example: 30 description: The amount of time to delay a job after @@ -83966,7 +84018,7 @@ paths: items: type: object properties: - type: *613 + type: *614 reviewer: anyOf: - *4 @@ -83990,7 +84042,7 @@ paths: - id - node_id - type - deployment_branch_policy: &617 + deployment_branch_policy: &618 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -84106,9 +84158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *456 - *457 - - &615 + - *458 + - &616 name: environment_name in: path required: true @@ -84121,9 +84173,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: &618 + default: &619 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84207,9 +84259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *456 - *457 - - *615 + - *458 + - *616 requestBody: required: false content: @@ -84218,7 +84270,7 @@ paths: type: object nullable: true properties: - wait_timer: *616 + wait_timer: *617 prevent_self_review: type: boolean example: false @@ -84235,13 +84287,13 @@ paths: items: type: object properties: - type: *613 + type: *614 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *617 + deployment_branch_policy: *618 additionalProperties: false examples: default: @@ -84261,9 +84313,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *618 + default: *619 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84287,9 +84339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *456 - *457 - - *615 + - *458 + - *616 responses: '204': description: Default response @@ -84314,9 +84366,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *17 - *19 responses: @@ -84334,7 +84386,7 @@ paths: example: 2 branch_policies: type: array - items: &619 + items: &620 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84391,9 +84443,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 + - *458 + - *616 requestBody: required: true content: @@ -84439,9 +84491,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - example-wildcard: &620 + example-wildcard: &621 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84483,10 +84535,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 - - &621 + - *458 + - *616 + - &622 name: branch_policy_id in: path required: true @@ -84498,9 +84550,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *620 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84519,10 +84571,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 - - *621 + - *458 + - *616 + - *622 requestBody: required: true content: @@ -84550,9 +84602,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *620 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84571,10 +84623,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 - - *621 + - *458 + - *616 + - *622 responses: '204': description: Response @@ -84599,9 +84651,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: - - *615 + - *616 + - *458 - *457 - - *456 responses: '200': description: List of deployment protection rules @@ -84617,7 +84669,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &622 + items: &623 title: Deployment protection rule description: Deployment protection rule type: object @@ -84636,7 +84688,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &623 + app: &624 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84735,9 +84787,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: - - *615 + - *616 + - *458 - *457 - - *456 requestBody: content: application/json: @@ -84758,9 +84810,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *622 + schema: *623 examples: - default: &624 + default: &625 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84795,9 +84847,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: - - *615 + - *616 + - *458 - *457 - - *456 - *19 - *17 responses: @@ -84816,7 +84868,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *623 + items: *624 examples: default: value: @@ -84851,10 +84903,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: - - *456 - *457 - - *615 - - &625 + - *458 + - *616 + - &626 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84866,9 +84918,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *623 examples: - default: *624 + default: *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84889,10 +84941,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: - - *615 + - *616 + - *458 - *457 - - *456 - - *625 + - *626 responses: '204': description: Response @@ -84918,9 +84970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *17 - *19 responses: @@ -84938,9 +84990,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *492 examples: - default: *492 + default: *493 headers: Link: *43 x-github: @@ -84965,17 +85017,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *456 - *457 - - *615 + - *458 + - *616 responses: '200': description: Response content: application/json: - schema: *493 + schema: *494 examples: - default: *494 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84997,18 +85049,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *492 examples: - default: *626 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85030,9 +85082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *284 requestBody: required: true @@ -85090,9 +85142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *284 responses: '204': @@ -85118,10 +85170,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *456 - *457 - - *615 - - *478 + - *458 + - *616 + - *479 - *19 responses: '200': @@ -85138,9 +85190,9 @@ paths: type: integer variables: type: array - items: *495 + items: *496 examples: - default: *496 + default: *497 headers: Link: *43 x-github: @@ -85163,9 +85215,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *456 - *457 - - *615 + - *458 + - *616 requestBody: required: true content: @@ -85217,18 +85269,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85249,10 +85301,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *456 - *457 + - *458 - *287 - - *615 + - *616 requestBody: required: true content: @@ -85294,10 +85346,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *456 - *457 + - *458 - *287 - - *615 + - *616 responses: '204': description: Response @@ -85319,8 +85371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -85388,8 +85440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *456 - *457 + - *458 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85548,8 +85600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -85581,9 +85633,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 '400': *14 '422': *15 '403': *29 @@ -85604,8 +85656,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -85665,7 +85717,7 @@ paths: schema: oneOf: - *249 - - *628 + - *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85690,8 +85742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *456 - *457 + - *458 - name: file_sha in: path required: true @@ -85790,8 +85842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -85900,7 +85952,7 @@ paths: description: Response content: application/json: - schema: &629 + schema: &630 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86114,15 +86166,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *456 - *457 - - *574 + - *458 + - *575 responses: '200': description: Response content: application/json: - schema: *629 + schema: *630 examples: default: value: @@ -86178,9 +86230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *456 - *457 - - &630 + - *458 + - &631 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. @@ -86197,7 +86249,7 @@ paths: application/json: schema: type: array - items: &631 + items: &632 title: Git Reference description: Git references within a repository type: object @@ -86272,17 +86324,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *456 - *457 - - *630 + - *458 + - *631 responses: '200': description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: &632 + default: &633 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86311,8 +86363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -86341,9 +86393,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -86369,9 +86421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *456 - *457 - - *630 + - *458 + - *631 requestBody: required: true content: @@ -86400,9 +86452,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 '422': *15 '409': *114 x-github: @@ -86420,9 +86472,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *456 - *457 - - *630 + - *458 + - *631 responses: '204': description: Response @@ -86477,8 +86529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -86545,7 +86597,7 @@ paths: description: Response content: application/json: - schema: &634 + schema: &635 title: Git Tag description: Metadata for a Git tag type: object @@ -86596,7 +86648,7 @@ paths: - sha - type - url - verification: *633 + verification: *634 required: - sha - url @@ -86606,7 +86658,7 @@ paths: - tag - message examples: - default: &635 + default: &636 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86679,8 +86731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *456 - *457 + - *458 - name: tag_sha in: path required: true @@ -86691,9 +86743,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: *635 + default: *636 '404': *6 '409': *114 x-github: @@ -86717,8 +86769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -86791,7 +86843,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &637 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86887,8 +86939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *456 - *457 + - *458 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86911,7 +86963,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: default-response: summary: Default response @@ -86970,8 +87022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -86981,7 +87033,7 @@ paths: application/json: schema: type: array - items: &637 + items: &638 title: Webhook description: Webhooks for repositories. type: object @@ -87035,7 +87087,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &891 title: Hook Response type: object properties: @@ -87109,8 +87161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -87162,9 +87214,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *638 examples: - default: &638 + default: &639 value: type: Repository id: 12345678 @@ -87212,17 +87264,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '200': description: Response content: application/json: - schema: *637 + schema: *638 examples: - default: *638 + default: *639 '404': *6 x-github: githubCloudOnly: false @@ -87242,8 +87294,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 requestBody: required: true @@ -87289,9 +87341,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *638 examples: - default: *638 + default: *639 '422': *15 '404': *6 x-github: @@ -87312,8 +87364,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '204': @@ -87338,8 +87390,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: - - *456 - *457 + - *458 - *337 responses: '200': @@ -87367,8 +87419,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: - - *456 - *457 + - *458 - *337 requestBody: required: false @@ -87413,8 +87465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 - *17 - *338 @@ -87446,8 +87498,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: - - *456 - *457 + - *458 - *337 - *16 responses: @@ -87476,8 +87528,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: - - *456 - *457 + - *458 - *337 - *16 responses: @@ -87501,8 +87553,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '204': @@ -87528,8 +87580,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '204': @@ -87553,8 +87605,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: - - *456 - *457 + - *458 responses: '200': description: Response if immutable releases are enabled @@ -87600,8 +87652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *456 - *457 + - *458 responses: '204': *150 '409': *114 @@ -87621,8 +87673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *456 - *457 + - *458 responses: '204': *150 '409': *114 @@ -87679,14 +87731,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: &639 + schema: &640 title: Import description: A repository import from an external source. type: object @@ -87785,7 +87837,7 @@ paths: - html_url - authors_url examples: - default: &642 + default: &643 value: vcs: subversion use_lfs: true @@ -87801,7 +87853,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': &640 + '503': &641 description: Unavailable due to service under maintenance. content: application/json: @@ -87830,8 +87882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -87879,7 +87931,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *640 examples: default: value: @@ -87904,7 +87956,7 @@ paths: type: string '422': *15 '404': *6 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87932,8 +87984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -87982,7 +88034,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *640 examples: example-1: summary: Example 1 @@ -88030,7 +88082,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': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88053,12 +88105,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *456 - *457 + - *458 responses: '204': description: Response - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88084,9 +88136,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *456 - *457 - - &830 + - *458 + - &831 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88100,7 +88152,7 @@ paths: application/json: schema: type: array - items: &641 + items: &642 title: Porter Author description: Porter Author type: object @@ -88154,7 +88206,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': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88179,8 +88231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *456 - *457 + - *458 - name: author_id in: path required: true @@ -88210,7 +88262,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -88223,7 +88275,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88247,8 +88299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -88289,7 +88341,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88317,8 +88369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -88345,11 +88397,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *640 examples: - default: *642 + default: *643 '422': *15 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88372,8 +88424,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -88381,8 +88433,8 @@ paths: application/json: schema: *22 examples: - default: *643 - '301': *468 + default: *644 + '301': *469 '404': *6 x-github: githubCloudOnly: false @@ -88402,8 +88454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -88416,7 +88468,7 @@ paths: properties: {} additionalProperties: false examples: - default: &645 + default: &646 value: limit: collaborators_only origin: repository @@ -88441,13 +88493,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: true content: application/json: - schema: *644 + schema: *645 examples: default: summary: Example request body @@ -88461,7 +88513,7 @@ paths: application/json: schema: *355 examples: - default: *645 + default: *646 '409': description: Response x-github: @@ -88483,8 +88535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -88507,8 +88559,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -88518,9 +88570,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: &823 + default: &824 value: - id: 1 repository: @@ -88651,8 +88703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *456 - *457 + - *458 - *359 requestBody: required: false @@ -88682,7 +88734,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: default: value: @@ -88813,8 +88865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *456 - *457 + - *458 - *359 responses: '204': @@ -88846,8 +88898,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *456 - *457 + - *458 - 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 @@ -88920,7 +88972,7 @@ paths: type: array items: *227 examples: - default: &656 + default: &657 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89068,7 +89120,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *468 + '301': *469 '422': *15 '404': *6 x-github: @@ -89097,8 +89149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -89182,7 +89234,7 @@ paths: application/json: schema: *227 examples: - default: &653 + default: &654 value: id: 1 node_id: MDU6SXNzdWUx @@ -89338,7 +89390,7 @@ paths: '422': *15 '503': *190 '404': *6 - '410': *647 + '410': *648 x-github: triggersNotification: true githubCloudOnly: false @@ -89366,8 +89418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *456 - *457 + - *458 - *237 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -89388,9 +89440,9 @@ paths: application/json: schema: type: array - items: *648 + items: *649 examples: - default: &655 + default: &656 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89448,17 +89500,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 responses: '200': description: Response content: application/json: - schema: *648 + schema: *649 examples: - default: &649 + default: &650 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89512,8 +89564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -89536,9 +89588,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: - default: *649 + default: *650 '422': *15 x-github: githubCloudOnly: false @@ -89556,8 +89608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 responses: '204': @@ -89578,8 +89630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -89606,9 +89658,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -89629,8 +89681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -89663,16 +89715,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -89694,10 +89746,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *456 - *457 + - *458 - *226 - - *448 + - *449 responses: '204': description: Response @@ -89717,8 +89769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -89728,7 +89780,7 @@ paths: application/json: schema: type: array - items: &652 + items: &653 title: Issue Event description: Issue Event type: object @@ -89771,8 +89823,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *650 - required: *651 + properties: *651 + required: *652 nullable: true label: title: Issue Event Label @@ -90079,8 +90131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *456 - *457 + - *458 - name: event_id in: path required: true @@ -90091,7 +90143,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -90284,7 +90336,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *647 + '410': *648 '403': *29 x-github: githubCloudOnly: false @@ -90318,9 +90370,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *456 - *457 - - &654 + - *458 + - &655 name: issue_number description: The number that identifies the issue. in: path @@ -90334,10 +90386,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *654 + '301': *469 '404': *6 - '410': *647 + '410': *648 '304': *37 x-github: githubCloudOnly: false @@ -90362,9 +90414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -90470,13 +90522,13 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 '422': *15 '503': *190 '403': *29 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90494,9 +90546,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -90524,7 +90576,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90540,9 +90592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: content: application/json: @@ -90569,7 +90621,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90591,9 +90643,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: - - *456 - *457 - - *654 + - *458 + - *655 - name: assignee in: path required: true @@ -90633,9 +90685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *217 - *17 - *19 @@ -90646,13 +90698,13 @@ paths: application/json: schema: type: array - items: *648 + items: *649 examples: - default: *655 + default: *656 headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90681,9 +90733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -90705,16 +90757,16 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: - default: *649 + default: *650 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *647 + '410': *648 '422': *15 '404': *6 x-github: @@ -90742,9 +90794,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: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -90756,12 +90808,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *657 headers: Link: *43 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90789,9 +90841,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: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -90815,15 +90867,15 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *468 + '301': *469 '403': *29 - '410': *647 + '410': *648 '422': *15 '404': *6 x-github: @@ -90854,9 +90906,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: - - *456 - *457 - - *654 + - *458 + - *655 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90870,13 +90922,13 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *654 + '301': *469 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *647 + '410': *648 x-github: triggersNotification: true githubCloudOnly: false @@ -90902,9 +90954,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: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -90916,12 +90968,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *657 headers: Link: *43 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90938,9 +90990,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -90954,7 +91006,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &659 + - &660 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91008,7 +91060,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &661 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91144,7 +91196,7 @@ paths: - performed_via_github_app - assignee - assigner - - &661 + - &662 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91195,7 +91247,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &663 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91246,7 +91298,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &664 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91300,7 +91352,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &665 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91347,7 +91399,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &666 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91394,7 +91446,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91454,7 +91506,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &668 title: Locked Issue Event description: Locked Issue Event type: object @@ -91502,7 +91554,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91568,7 +91620,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91634,7 +91686,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91700,7 +91752,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &672 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91791,7 +91843,7 @@ paths: color: red headers: Link: *43 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91808,9 +91860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -91820,7 +91872,7 @@ paths: application/json: schema: type: array - items: &657 + items: &658 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91867,7 +91919,7 @@ paths: - color - default examples: - default: &658 + default: &659 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91885,9 +91937,9 @@ paths: default: false headers: Link: *43 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91904,9 +91956,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -91965,12 +92017,12 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 - '301': *468 + default: *659 + '301': *469 '404': *6 - '410': *647 + '410': *648 '422': *15 x-github: githubCloudOnly: false @@ -91987,9 +92039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -92049,12 +92101,12 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 - '301': *468 + default: *659 + '301': *469 '404': *6 - '410': *647 + '410': *648 '422': *15 x-github: githubCloudOnly: false @@ -92071,15 +92123,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 responses: '204': description: Response - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92098,9 +92150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - name: name in: path required: true @@ -92113,7 +92165,7 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: default: value: @@ -92124,9 +92176,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92146,9 +92198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -92176,7 +92228,7 @@ paths: '204': description: Response '403': *29 - '410': *647 + '410': *648 '404': *6 '422': *15 x-github: @@ -92194,9 +92246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 responses: '204': description: Response @@ -92226,9 +92278,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 responses: '200': description: Response @@ -92236,10 +92288,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *654 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92256,9 +92308,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - 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. @@ -92284,13 +92336,13 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92308,9 +92360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92342,16 +92394,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -92373,10 +92425,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *456 - *457 - - *654 - - *448 + - *458 + - *655 + - *449 responses: '204': description: Response @@ -92405,9 +92457,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92431,7 +92483,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92464,9 +92516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -92478,11 +92530,11 @@ paths: type: array items: *227 examples: - default: *656 + default: *657 headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92510,9 +92562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92541,14 +92593,14 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *647 + '410': *648 '422': *15 '404': *6 x-github: @@ -92568,9 +92620,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92603,7 +92655,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 '403': *29 '404': *6 '422': *7 @@ -92625,9 +92677,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -92642,7 +92694,6 @@ paths: description: Timeline Event type: object anyOf: - - *659 - *660 - *661 - *662 @@ -92655,6 +92706,7 @@ paths: - *669 - *670 - *671 + - *672 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92963,7 +93015,7 @@ paths: type: string comments: type: array - items: &693 + items: &694 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93172,7 +93224,7 @@ paths: type: string comments: type: array - items: *572 + items: *573 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93461,7 +93513,7 @@ paths: headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93478,8 +93530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -93489,7 +93541,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93555,8 +93607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -93592,9 +93644,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: id: 1 key: ssh-rsa AAA... @@ -93628,9 +93680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *456 - *457 - - &674 + - *458 + - &675 name: key_id description: The unique identifier of the key. in: path @@ -93642,9 +93694,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +93714,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *456 - *457 - - *674 + - *458 + - *675 responses: '204': description: Response @@ -93684,8 +93736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -93695,9 +93747,9 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 + default: *659 headers: Link: *43 '404': *6 @@ -93718,8 +93770,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -93755,9 +93807,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: - default: &675 + default: &676 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93789,8 +93841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *456 - *457 + - *458 - name: name in: path required: true @@ -93801,9 +93853,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: - default: *675 + default: *676 '404': *6 x-github: githubCloudOnly: false @@ -93820,8 +93872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *456 - *457 + - *458 - name: name in: path required: true @@ -93860,7 +93912,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: default: value: @@ -93886,8 +93938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *456 - *457 + - *458 - name: name in: path required: true @@ -93913,8 +93965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -93950,8 +94002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *456 - *457 + - *458 responses: '202': *39 '403': @@ -93979,8 +94031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -94006,9 +94058,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *456 - *457 - - *548 + - *458 + - *549 responses: '200': description: Response @@ -94153,8 +94205,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94219,8 +94271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94254,9 +94306,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *573 + schema: *574 examples: - default: *676 + default: *677 '204': description: Response when already merged '404': @@ -94281,8 +94333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *456 - *457 + - *458 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94323,7 +94375,7 @@ paths: application/json: schema: type: array - items: &677 + items: &678 title: Milestone description: A collection of related issues and pull requests. type: object @@ -94384,8 +94436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94425,9 +94477,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: - default: &678 + default: &679 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94486,9 +94538,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *456 - *457 - - &679 + - *458 + - &680 name: milestone_number description: The number that identifies the milestone. in: path @@ -94500,9 +94552,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: - default: *678 + default: *679 '404': *6 x-github: githubCloudOnly: false @@ -94519,9 +94571,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *456 - *457 - - *679 + - *458 + - *680 requestBody: required: false content: @@ -94559,9 +94611,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: - default: *678 + default: *679 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94577,9 +94629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *456 - *457 - - *679 + - *458 + - *680 responses: '204': description: Response @@ -94600,9 +94652,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: - - *456 - *457 - - *679 + - *458 + - *680 - *17 - *19 responses: @@ -94612,9 +94664,9 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 + default: *659 headers: Link: *43 x-github: @@ -94633,12 +94685,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: - - *456 - *457 - - *680 + - *458 - *681 - - *217 - *682 + - *217 + - *683 - *17 - *19 responses: @@ -94650,7 +94702,7 @@ paths: type: array items: *240 examples: - default: *683 + default: *684 headers: Link: *43 x-github: @@ -94674,8 +94726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -94733,14 +94785,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: &684 + schema: &685 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94865,7 +94917,7 @@ paths: - custom_404 - public examples: - default: &685 + default: &686 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94906,8 +94958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94961,9 +95013,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: - default: *685 + default: *686 '422': *15 '409': *114 x-github: @@ -94986,8 +95038,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -95094,8 +95146,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -95121,8 +95173,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -95132,7 +95184,7 @@ paths: application/json: schema: type: array - items: &686 + items: &687 title: Page Build description: Page Build type: object @@ -95226,8 +95278,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *456 - *457 + - *458 responses: '201': description: Response @@ -95272,16 +95324,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *686 + schema: *687 examples: - default: &687 + default: &688 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95329,8 +95381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *456 - *457 + - *458 - name: build_id in: path required: true @@ -95341,9 +95393,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *687 examples: - default: *687 + default: *688 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95363,8 +95415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -95469,9 +95521,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: - - *456 - *457 - - &688 + - *458 + - &689 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95529,9 +95581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *456 - *457 - - *688 + - *458 + - *689 responses: '204': *150 '404': *6 @@ -95558,8 +95610,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -95817,8 +95869,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: - - *456 - *457 + - *458 responses: '200': description: Private vulnerability reporting status @@ -95855,8 +95907,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: - - *456 - *457 + - *458 responses: '204': *150 '422': *14 @@ -95877,8 +95929,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: - - *456 - *457 + - *458 responses: '204': *150 '422': *14 @@ -95900,8 +95952,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -95911,7 +95963,7 @@ paths: type: array items: *151 examples: - default: *689 + default: *690 '403': *29 '404': *6 x-github: @@ -95933,8 +95985,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -95950,7 +96002,7 @@ paths: required: - properties examples: - default: *690 + default: *691 responses: '204': description: No Content when custom property values are successfully created @@ -95988,8 +96040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *456 - *457 + - *458 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96049,9 +96101,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *691 + default: *692 headers: Link: *43 '304': *37 @@ -96083,8 +96135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -96149,7 +96201,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &696 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96306,7 +96358,7 @@ paths: nullable: true requested_teams: type: array - items: *429 + items: *430 nullable: true head: type: object @@ -96363,7 +96415,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: *692 + auto_merge: *693 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96455,7 +96507,7 @@ paths: - merged_by - review_comments examples: - default: &696 + default: &697 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96982,8 +97034,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *456 - *457 + - *458 - name: sort in: query required: false @@ -97012,9 +97064,9 @@ paths: application/json: schema: type: array - items: *693 + items: *694 examples: - default: &698 + default: &699 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97091,17 +97143,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: - - *456 - *457 + - *458 - *226 responses: '200': description: Response content: application/json: - schema: *693 + schema: *694 examples: - default: &694 + default: &695 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97176,8 +97228,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: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -97200,9 +97252,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: - default: *694 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97218,8 +97270,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: - - *456 - *457 + - *458 - *226 responses: '204': @@ -97241,8 +97293,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: - - *456 - *457 + - *458 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -97269,9 +97321,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -97292,8 +97344,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: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -97326,16 +97378,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -97357,10 +97409,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *456 - *457 + - *458 - *226 - - *448 + - *449 responses: '204': description: Response @@ -97403,9 +97455,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *456 - *457 - - &697 + - *458 + - &698 name: pull_number description: The number that identifies the pull request. in: path @@ -97418,9 +97470,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *695 + schema: *696 examples: - default: *696 + default: *697 '304': *37 '404': *6 '406': @@ -97455,9 +97507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -97499,9 +97551,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *696 examples: - default: *696 + default: *697 '422': *15 '403': *29 x-github: @@ -97523,9 +97575,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: true content: @@ -97587,7 +97639,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97595,7 +97647,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '401': *25 '403': *29 '404': *6 @@ -97625,9 +97677,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: - - *456 - *457 - - *697 + - *458 + - *698 - *237 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -97648,9 +97700,9 @@ paths: application/json: schema: type: array - items: *693 + items: *694 examples: - default: *698 + default: *699 headers: Link: *43 x-github: @@ -97683,9 +97735,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: true content: @@ -97790,7 +97842,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: example-for-a-multi-line-comment: value: @@ -97878,9 +97930,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: - - *456 - *457 - - *697 + - *458 + - *698 - *226 requestBody: required: true @@ -97903,7 +97955,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: default: value: @@ -97989,9 +98041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 - *17 - *19 responses: @@ -98001,9 +98053,9 @@ paths: application/json: schema: type: array - items: *573 + items: *574 examples: - default: *699 + default: *700 headers: Link: *43 x-github: @@ -98033,9 +98085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *456 - *457 - - *697 + - *458 + - *698 - *17 - *19 responses: @@ -98045,7 +98097,7 @@ paths: application/json: schema: type: array - items: *586 + items: *587 examples: default: value: @@ -98083,9 +98135,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: - - *456 - *457 - - *697 + - *458 + - *698 responses: '204': description: Response if pull request has been merged @@ -98108,9 +98160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -98221,9 +98273,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: - - *456 - *457 - - *697 + - *458 + - *698 responses: '200': description: Response @@ -98298,9 +98350,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -98337,7 +98389,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: default: value: @@ -98873,9 +98925,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: true content: @@ -98909,7 +98961,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: default: value: @@ -99414,9 +99466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 - *17 - *19 responses: @@ -99426,7 +99478,7 @@ paths: application/json: schema: type: array - items: &700 + items: &701 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99577,9 +99629,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -99665,9 +99717,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &702 + default: &703 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99730,10 +99782,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: - - *456 - *457 - - *697 - - &701 + - *458 + - *698 + - &702 name: review_id description: The unique identifier of the review. in: path @@ -99745,9 +99797,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &703 + default: &704 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99806,10 +99858,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 requestBody: required: true content: @@ -99832,7 +99884,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: default: value: @@ -99894,18 +99946,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 responses: '200': description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *702 + default: *703 '422': *7 '404': *6 x-github: @@ -99932,10 +99984,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 - *17 - *19 responses: @@ -100170,10 +100222,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 requestBody: required: true content: @@ -100201,7 +100253,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: default: value: @@ -100264,10 +100316,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 requestBody: required: true content: @@ -100302,9 +100354,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *703 + default: *704 '404': *6 '422': *7 '403': *29 @@ -100326,9 +100378,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -100391,8 +100443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *456 - *457 + - *458 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100405,9 +100457,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *705 examples: - default: &705 + default: &706 value: type: file encoding: base64 @@ -100449,8 +100501,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: - - *456 - *457 + - *458 - name: dir description: The alternate path to look for a README file in: path @@ -100470,9 +100522,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *705 examples: - default: *705 + default: *706 '404': *6 '422': *15 x-github: @@ -100494,8 +100546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -100505,7 +100557,7 @@ paths: application/json: schema: type: array - items: &706 + items: &707 title: Release description: A release. type: object @@ -100576,7 +100628,7 @@ paths: author: *4 assets: type: array - items: &707 + items: &708 title: Release Asset description: Data related to a release. type: object @@ -100763,8 +100815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -100840,9 +100892,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &710 + default: &711 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100947,9 +100999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *456 - *457 - - &708 + - *458 + - &709 name: asset_id description: The unique identifier of the asset. in: path @@ -100961,9 +101013,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: &709 + default: &710 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 @@ -100998,7 +101050,7 @@ paths: type: User site_admin: false '404': *6 - '302': *588 + '302': *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101014,9 +101066,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *456 - *457 - - *708 + - *458 + - *709 requestBody: required: false content: @@ -101044,9 +101096,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: *709 + default: *710 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101062,9 +101114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *456 - *457 - - *708 + - *458 + - *709 responses: '204': description: Response @@ -101088,8 +101140,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -101174,16 +101226,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *710 + default: *711 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101200,8 +101252,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *456 - *457 + - *458 - name: tag description: tag parameter in: path @@ -101214,9 +101266,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *710 + default: *711 '404': *6 x-github: githubCloudOnly: false @@ -101238,9 +101290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *456 - *457 - - &711 + - *458 + - &712 name: release_id description: The unique identifier of the release. in: path @@ -101254,9 +101306,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: *706 + schema: *707 examples: - default: *710 + default: *711 '401': description: Unauthorized x-github: @@ -101274,9 +101326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 requestBody: required: false content: @@ -101340,9 +101392,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *710 + default: *711 '404': description: Not Found if the discussion category name is invalid content: @@ -101363,9 +101415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 responses: '204': description: Response @@ -101385,9 +101437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *456 - *457 - - *711 + - *458 + - *712 - *17 - *19 responses: @@ -101397,7 +101449,7 @@ paths: application/json: schema: type: array - items: *707 + items: *708 examples: default: value: @@ -101479,9 +101531,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: - - *456 - *457 - - *711 + - *458 + - *712 - name: name in: query required: true @@ -101507,7 +101559,7 @@ paths: description: Response for successful upload content: application/json: - schema: *707 + schema: *708 examples: response-for-successful-upload: value: @@ -101562,9 +101614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 - 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. @@ -101588,9 +101640,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -101611,9 +101663,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 requestBody: required: true content: @@ -101643,16 +101695,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -101674,10 +101726,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *456 - *457 - - *711 - - *448 + - *458 + - *712 + - *449 responses: '204': description: Response @@ -101701,9 +101753,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *456 - *457 - - *513 + - *458 + - *514 - *17 - *19 responses: @@ -101720,7 +101772,7 @@ paths: oneOf: - allOf: - *165 - - &712 + - &713 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101741,67 +101793,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *166 - - *712 + - *713 - allOf: - *167 - - *712 + - *713 - allOf: - *168 - - *712 + - *713 - allOf: + - *714 - *713 - - *712 - allOf: - *169 - - *712 + - *713 - allOf: - *170 - - *712 + - *713 - allOf: - *171 - - *712 + - *713 - allOf: - *172 - - *712 + - *713 - allOf: - *173 - - *712 + - *713 - allOf: - *174 - - *712 + - *713 - allOf: - *175 - - *712 + - *713 - allOf: - *176 - - *712 + - *713 - allOf: - *177 - - *712 + - *713 - allOf: - *178 - - *712 + - *713 - allOf: - *179 - - *712 + - *713 - allOf: - *180 - - *712 + - *713 - allOf: - *181 - - *712 + - *713 - allOf: - *182 - - *712 + - *713 - allOf: - *183 - - *712 + - *713 - allOf: - *184 - - *712 + - *713 - allOf: - - *714 - - *712 + - *715 + - *713 examples: default: value: @@ -101840,8 +101892,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - *17 - *19 - name: includes_parents @@ -101852,7 +101904,7 @@ paths: schema: type: boolean default: true - - *715 + - *716 responses: '200': description: Response @@ -101907,8 +101959,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 requestBody: description: Request body required: true @@ -101937,7 +101989,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *716 + items: *717 required: - name - enforcement @@ -101970,7 +102022,7 @@ paths: application/json: schema: *185 examples: - default: &725 + default: &726 value: id: 42 name: super cool ruleset @@ -102017,12 +102069,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *456 - *457 - - *717 - - *101 + - *458 - *718 + - *101 - *719 + - *720 - *17 - *19 responses: @@ -102030,9 +102082,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *721 examples: - default: *721 + default: *722 '404': *6 '500': *40 x-github: @@ -102053,17 +102105,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *456 - *457 - - *722 + - *458 + - *723 responses: '200': description: Response content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 '404': *6 '500': *40 x-github: @@ -102091,8 +102143,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102114,7 +102166,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *726 '404': *6 '500': *40 put: @@ -102132,8 +102184,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102167,7 +102219,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *716 + items: *717 examples: default: value: @@ -102197,7 +102249,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *726 '404': *6 '500': *40 delete: @@ -102215,8 +102267,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102239,8 +102291,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *456 - *457 + - *458 - *17 - *19 - name: ruleset_id @@ -102277,8 +102329,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102351,21 +102403,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: - - *456 - *457 + - *458 - *416 - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - *726 - *727 - - *420 + - *728 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -102373,7 +102426,7 @@ paths: application/json: schema: type: array - items: &731 + items: &732 type: object properties: number: *123 @@ -102392,8 +102445,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolved_at: type: string format: date-time @@ -102489,7 +102542,7 @@ paths: pull request. ' - oneOf: *730 + oneOf: *731 nullable: true has_more_locations: type: boolean @@ -102638,16 +102691,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: - - *456 - *457 - - *542 - - *423 + - *458 + - *543 + - *424 responses: '200': description: Response content: application/json: - schema: *731 + schema: *732 examples: default: value: @@ -102689,6 +102742,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. @@ -102699,9 +102754,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: - - *456 - *457 - - *542 + - *458 + - *543 requestBody: required: true content: @@ -102709,27 +102764,42 @@ paths: schema: type: object properties: - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *731 + schema: *732 examples: default: value: @@ -102774,6 +102844,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. @@ -102781,7 +102870,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': *190 x-github: enabledForGitHubApps: true @@ -102804,9 +102894,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: - - *456 - *457 - - *542 + - *458 + - *543 - *19 - *17 responses: @@ -102817,7 +102907,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &912 + items: &913 type: object properties: type: @@ -102843,7 +102933,6 @@ paths: example: commit details: oneOf: - - *732 - *733 - *734 - *735 @@ -102856,6 +102945,7 @@ paths: - *742 - *743 - *744 + - *745 examples: default: value: @@ -102941,8 +103031,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -102950,14 +103040,14 @@ paths: schema: type: object properties: - reason: &746 + reason: &747 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *745 + placeholder_id: *746 required: - reason - placeholder_id @@ -102974,7 +103064,7 @@ paths: schema: type: object properties: - reason: *746 + reason: *747 expire_at: type: string format: date-time @@ -103020,8 +103110,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: - - *456 - *457 + - *458 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -103036,7 +103126,7 @@ paths: properties: incremental_scans: type: array - items: &747 + items: &748 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103062,15 +103152,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *747 + items: *748 backfill_scans: type: array - items: *747 + items: *748 custom_pattern_backfill_scans: type: array items: allOf: - - *747 + - *748 - type: object properties: pattern_name: @@ -103140,8 +103230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *456 - *457 + - *458 - *106 - name: sort description: The property to sort the results by. @@ -103185,9 +103275,9 @@ paths: application/json: schema: type: array - items: *748 + items: *749 examples: - default: *749 + default: *750 '400': *14 '404': *6 x-github: @@ -103210,8 +103300,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -103284,7 +103374,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -103371,9 +103461,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: &751 + default: &752 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103606,8 +103696,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -103711,7 +103801,7 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: default: value: @@ -103858,17 +103948,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: - - *456 - *457 - - *750 + - *458 + - *751 responses: '200': description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 + default: *752 '403': *29 '404': *6 x-github: @@ -103892,9 +103982,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: - - *456 - *457 - - *750 + - *458 + - *751 requestBody: required: true content: @@ -103967,7 +104057,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -104053,10 +104143,10 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 - add_credit: *751 + default: *752 + add_credit: *752 '403': *29 '404': *6 '422': @@ -104094,9 +104184,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: - - *456 - *457 - - *750 + - *458 + - *751 responses: '202': *39 '400': *14 @@ -104123,17 +104213,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: - - *456 - *457 - - *750 + - *458 + - *751 responses: '202': description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 '400': *14 '422': *15 '403': *29 @@ -104159,8 +104249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -104259,8 +104349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *456 - *457 + - *458 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104269,7 +104359,7 @@ paths: application/json: schema: type: array - items: &752 + items: &753 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104302,8 +104392,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -104379,8 +104469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -104476,8 +104566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *456 - *457 + - *458 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104631,8 +104721,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: - - *456 - *457 + - *458 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104642,7 +104732,7 @@ paths: application/json: schema: type: array - items: *752 + items: *753 examples: default: value: @@ -104675,8 +104765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *456 - *457 + - *458 - name: sha in: path required: true @@ -104730,7 +104820,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -104784,8 +104874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -104817,14 +104907,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *456 - *457 + - *458 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &754 + schema: &755 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104892,8 +104982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -104919,7 +105009,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *755 examples: default: value: @@ -104946,8 +105036,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -104967,8 +105057,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -105047,8 +105137,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -105056,7 +105146,7 @@ paths: application/json: schema: type: array - items: &755 + items: &756 title: Tag protection description: Tag protection type: object @@ -105108,8 +105198,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -105132,7 +105222,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *756 examples: default: value: @@ -105163,8 +105253,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: - - *456 - *457 + - *458 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105201,8 +105291,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *456 - *457 + - *458 - name: ref in: path required: true @@ -105238,8 +105328,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -105271,8 +105361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *456 - *457 + - *458 - *19 - *17 responses: @@ -105280,7 +105370,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &757 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105292,7 +105382,7 @@ paths: required: - names examples: - default: &757 + default: &758 value: names: - octocat @@ -105315,8 +105405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -105347,9 +105437,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *757 examples: - default: *757 + default: *758 '404': *6 '422': *7 x-github: @@ -105370,9 +105460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *456 - *457 - - &758 + - *458 + - &759 name: per description: The time frame to display results for. in: query @@ -105401,7 +105491,7 @@ paths: example: 128 clones: type: array - items: &759 + items: &760 title: Traffic type: object properties: @@ -105488,8 +105578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -105579,8 +105669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -105640,9 +105730,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *456 - *457 - - *758 + - *458 + - *759 responses: '200': description: Response @@ -105661,7 +105751,7 @@ paths: example: 3782 views: type: array - items: *759 + items: *760 required: - uniques - count @@ -105738,8 +105828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -106013,8 +106103,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: - - *456 - *457 + - *458 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106037,8 +106127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -106060,8 +106150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -106087,8 +106177,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *456 - *457 + - *458 - name: ref in: path required: true @@ -106180,9 +106270,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106333,7 +106423,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &768 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106342,7 +106432,7 @@ paths: schema: type: string example: members - - &772 + - &773 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106353,7 +106443,7 @@ paths: default: 1 format: int32 example: 1 - - &773 + - &774 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106395,7 +106485,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &763 allOf: - type: object required: @@ -106470,7 +106560,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: &774 + meta: &775 type: object description: The metadata associated with the creation/updates to the user. @@ -106530,30 +106620,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &764 description: Bad request content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *761 + '401': *762 + '403': &765 description: Permission denied - '429': &765 + '429': &766 description: Too many requests content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '500': &766 + schema: *761 + '500': &767 description: Internal server error content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 + schema: *761 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106577,7 +106667,7 @@ paths: required: true content: application/json: - schema: &770 + schema: &771 type: object required: - schemas @@ -106637,9 +106727,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *763 examples: - group: &768 + group: &769 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106658,13 +106748,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': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *764 + '401': *762 + '403': *765 + '409': &772 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106681,7 +106771,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: - - &769 + - &770 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106689,22 +106779,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *768 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *763 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106723,13 +106813,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: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: *770 + schema: *771 examples: group: summary: Group @@ -106755,17 +106845,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *769 + groupWithMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106789,13 +106879,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: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: &781 + schema: &782 type: object required: - Operations @@ -106855,17 +106945,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *769 + addMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106881,17 +106971,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: - - *769 + - *770 - *41 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106925,8 +107015,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - *773 + - *774 - *41 responses: '200': @@ -106959,7 +107049,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &777 allOf: - type: object required: @@ -107038,7 +107128,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &775 + roles: &776 type: array description: The roles assigned to the user. items: @@ -107094,7 +107184,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *775 startIndex: type: integer description: A starting index for the returned page @@ -107131,11 +107221,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *764 + '401': *762 + '403': *765 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107159,7 +107249,7 @@ paths: required: true content: application/json: - schema: &779 + schema: &780 type: object required: - schemas @@ -107241,9 +107331,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *775 + roles: *776 examples: - user: &780 + user: &781 summary: User value: schemas: @@ -107290,9 +107380,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *777 examples: - user: &777 + user: &778 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107318,13 +107408,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: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *778 + '400': *764 + '401': *762 + '403': *765 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107341,7 +107431,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: - - &778 + - &779 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107354,15 +107444,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *777 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107384,30 +107474,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: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *779 + schema: *780 examples: - user: *780 + user: *781 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107442,13 +107532,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: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *782 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107488,18 +107578,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *778 + userSingleValuedProperties: *778 + disableUser: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107519,17 +107609,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: - - *778 + - *779 - *41 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107616,7 +107706,7 @@ paths: example: 1 Resources: type: array - items: &782 + items: &783 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107847,22 +107937,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': *37 - '404': &783 + '404': &784 description: Resource not found content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '403': &784 + schema: *761 + '403': &785 description: Forbidden content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *761 + '400': *764 + '429': *766 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107888,9 +107978,9 @@ paths: description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: &785 + default: &786 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107913,17 +108003,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': *37 - '404': *783 - '403': *784 - '500': *766 + '404': *784 + '403': *785 + '500': *767 '409': description: Conflict content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 + schema: *761 + '400': *764 requestBody: required: true content: @@ -108021,17 +108111,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *83 - - *778 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 - '404': *783 - '403': *784 + default: *786 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108055,18 +108145,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *83 - - *778 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 + '404': *784 + '403': *785 requestBody: required: true content: @@ -108179,19 +108269,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *83 - - *778 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 - '400': *763 + '404': *784 + '403': *785 + '400': *764 '429': description: Response content: @@ -108282,12 +108372,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *83 - - *778 + - *779 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108420,7 +108510,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &786 + text_matches: &787 title: Search Result Text Matches type: array items: @@ -108583,7 +108673,7 @@ paths: enum: - author-date - committer-date - - &787 + - &788 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 @@ -108654,7 +108744,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *512 nullable: true comment_count: type: integer @@ -108674,7 +108764,7 @@ paths: url: type: string format: uri - verification: *633 + verification: *634 required: - author - committer @@ -108693,7 +108783,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *512 nullable: true parents: type: array @@ -108711,7 +108801,7 @@ paths: type: number node_id: type: string - text_matches: *786 + text_matches: *787 required: - sha - node_id @@ -108904,7 +108994,7 @@ paths: - interactions - created - updated - - *787 + - *788 - *17 - *19 - name: advanced_search @@ -109001,11 +109091,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: type: string state_reason: @@ -109037,7 +109127,7 @@ paths: type: string format: date-time nullable: true - text_matches: *786 + text_matches: *787 pull_request: type: object properties: @@ -109262,7 +109352,7 @@ paths: enum: - created - updated - - *787 + - *788 - *17 - *19 responses: @@ -109306,7 +109396,7 @@ paths: nullable: true score: type: number - text_matches: *786 + text_matches: *787 required: - id - node_id @@ -109392,7 +109482,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *788 - *17 - *19 responses: @@ -109631,7 +109721,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *787 temp_clone_token: type: string allow_merge_commit: @@ -109932,7 +110022,7 @@ paths: type: string format: uri nullable: true - text_matches: *786 + text_matches: *787 related: type: array nullable: true @@ -110125,7 +110215,7 @@ paths: - followers - repositories - joined - - *787 + - *788 - *17 - *19 responses: @@ -110229,7 +110319,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *786 + text_matches: *787 blog: type: string nullable: true @@ -110308,7 +110398,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &791 + - &792 name: team_id description: The unique identifier of the team. in: path @@ -110320,9 +110410,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -110349,7 +110439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110412,16 +110502,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -110449,7 +110539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *791 + - *792 responses: '204': description: Response @@ -110480,7 +110570,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *791 + - *792 - *106 - *17 - *19 @@ -110491,9 +110581,9 @@ paths: application/json: schema: type: array - items: *439 + items: *440 examples: - default: *792 + default: *793 headers: Link: *43 x-github: @@ -110522,7 +110612,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110556,9 +110646,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: triggersNotification: true githubCloudOnly: false @@ -110585,16 +110675,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *442 responses: '200': description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110619,8 +110709,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *442 requestBody: required: false content: @@ -110643,9 +110733,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *793 + default: *794 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110670,8 +110760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *442 responses: '204': description: Response @@ -110700,8 +110790,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *791 - - *441 + - *792 + - *442 - *106 - *17 - *19 @@ -110712,9 +110802,9 @@ paths: application/json: schema: type: array - items: *442 + items: *443 examples: - default: *794 + default: *795 headers: Link: *43 x-github: @@ -110743,8 +110833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *791 - - *441 + - *792 + - *442 requestBody: required: true content: @@ -110766,9 +110856,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: triggersNotification: true githubCloudOnly: false @@ -110795,17 +110885,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 responses: '200': description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110830,9 +110920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 requestBody: required: true content: @@ -110854,9 +110944,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *795 + default: *796 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110881,9 +110971,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 responses: '204': description: Response @@ -110912,9 +111002,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: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 - 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. @@ -110940,9 +111030,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -110971,9 +111061,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: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 requestBody: required: true content: @@ -111005,9 +111095,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111033,8 +111123,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: - - *791 - - *441 + - *792 + - *442 - 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. @@ -111060,9 +111150,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -111091,8 +111181,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: - - *791 - - *441 + - *792 + - *442 requestBody: required: true content: @@ -111124,9 +111214,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111150,7 +111240,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111188,7 +111278,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *791 + - *792 - name: role description: Filters members returned by their role in the team. in: query @@ -111239,7 +111329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *791 + - *792 - *138 responses: '204': @@ -111276,7 +111366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *791 + - *792 - *138 responses: '204': @@ -111316,7 +111406,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *791 + - *792 - *138 responses: '204': @@ -111353,16 +111443,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: - - *791 + - *792 - *138 responses: '200': description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-user-is-a-team-maintainer: *796 + response-if-user-is-a-team-maintainer: *797 '404': *6 x-github: githubCloudOnly: false @@ -111395,7 +111485,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: - - *791 + - *792 - *138 requestBody: required: false @@ -111421,9 +111511,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: *797 + response-if-users-membership-with-team-is-now-pending: *798 '403': description: Forbidden if team synchronization is set up '422': @@ -111457,7 +111547,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: - - *791 + - *792 - *138 responses: '204': @@ -111486,7 +111576,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111496,9 +111586,9 @@ paths: application/json: schema: type: array - items: *454 + items: *455 examples: - default: *798 + default: *799 headers: Link: *43 '404': *6 @@ -111524,16 +111614,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: - - *791 - - *455 + - *792 + - *456 responses: '200': description: Response content: application/json: - schema: *454 + schema: *455 examples: - default: *799 + default: *800 '404': description: Not Found if project is not managed by this team x-github: @@ -111557,8 +111647,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: - - *791 - - *455 + - *792 + - *456 requestBody: required: false content: @@ -111625,8 +111715,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: - - *791 - - *455 + - *792 + - *456 responses: '204': description: Response @@ -111653,7 +111743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111695,15 +111785,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: - - *791 - - *456 + - *792 - *457 + - *458 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *800 + schema: *801 examples: alternative-response-with-extra-repository-information: value: @@ -111854,9 +111944,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: - - *791 - - *456 + - *792 - *457 + - *458 requestBody: required: false content: @@ -111906,9 +111996,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: - - *791 - - *456 + - *792 - *457 + - *458 responses: '204': description: Response @@ -111937,15 +112027,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: - - *791 + - *792 responses: '200': description: Response content: application/json: - schema: *458 + schema: *459 examples: - default: *459 + default: *460 '403': *29 '404': *6 x-github: @@ -111972,7 +112062,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: - - *791 + - *792 requestBody: required: true content: @@ -112029,7 +112119,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *459 examples: default: value: @@ -112060,7 +112150,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -112072,7 +112162,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: *801 + response-if-child-teams-exist: *802 headers: Link: *43 '404': *6 @@ -112105,7 +112195,7 @@ paths: application/json: schema: oneOf: - - &803 + - &804 title: Private User description: Private User type: object @@ -112308,7 +112398,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *802 + - *803 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112461,7 +112551,7 @@ paths: description: Response content: application/json: - schema: *803 + schema: *804 examples: default: value: @@ -112807,7 +112897,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -112815,7 +112905,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '401': *25 '403': *29 '404': *6 @@ -112859,7 +112949,7 @@ paths: type: integer secrets: type: array - items: &804 + items: &805 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112899,7 +112989,7 @@ paths: - visibility - selected_repositories_url examples: - default: *565 + default: *566 headers: Link: *43 x-github: @@ -112975,7 +113065,7 @@ paths: description: Response content: application/json: - schema: *804 + schema: *805 examples: default: value: @@ -113121,7 +113211,7 @@ paths: type: array items: *274 examples: - default: *805 + default: *806 '401': *25 '403': *29 '404': *6 @@ -113273,7 +113363,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '304': *37 '500': *40 '401': *25 @@ -113331,7 +113421,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '401': *25 '403': *29 '404': *6 @@ -113388,7 +113478,7 @@ paths: description: Response content: application/json: - schema: &806 + schema: &807 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113429,7 +113519,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &807 + default: &808 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113474,9 +113564,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *807 examples: - default: *807 + default: *808 '404': *6 x-github: githubCloudOnly: false @@ -113513,9 +113603,9 @@ paths: type: integer machines: type: array - items: *808 + items: *809 examples: - default: *809 + default: *810 '304': *37 '500': *40 '401': *25 @@ -113594,13 +113684,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *467 + repository: *468 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *564 + required: *565 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114382,7 +114472,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '304': *37 '500': *40 '400': *14 @@ -114422,7 +114512,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '500': *40 '401': *25 '403': *29 @@ -114454,7 +114544,7 @@ paths: type: array items: *376 examples: - default: &820 + default: &821 value: - id: 197 name: hello_docker @@ -114555,7 +114645,7 @@ paths: application/json: schema: type: array - items: &810 + items: &811 title: Email description: Email type: object @@ -114620,9 +114710,9 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: - default: &822 + default: &823 value: - email: octocat@github.com verified: true @@ -114697,7 +114787,7 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: default: value: @@ -114953,7 +115043,7 @@ paths: application/json: schema: type: array - items: &811 + items: &812 title: GPG Key description: A unique encryption key type: object @@ -115084,7 +115174,7 @@ paths: - subkeys - revoked examples: - default: &836 + default: &837 value: - id: 3 name: Octocat's GPG Key @@ -115169,9 +115259,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *812 examples: - default: &812 + default: &813 value: id: 3 name: Octocat's GPG Key @@ -115228,7 +115318,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: - - &813 + - &814 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115240,9 +115330,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *812 examples: - default: *812 + default: *813 '404': *6 '304': *37 '403': *29 @@ -115265,7 +115355,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: - - *813 + - *814 responses: '204': description: Response @@ -115570,7 +115660,7 @@ paths: required: true content: application/json: - schema: *644 + schema: *645 examples: default: value: @@ -115720,7 +115810,7 @@ paths: application/json: schema: type: array - items: &814 + items: &815 title: Key description: Key type: object @@ -115821,9 +115911,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *815 examples: - default: &815 + default: &816 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115856,15 +115946,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: - - *674 + - *675 responses: '200': description: Response content: application/json: - schema: *814 + schema: *815 examples: - default: *815 + default: *816 '404': *6 '304': *37 '403': *29 @@ -115887,7 +115977,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: - - *674 + - *675 responses: '204': description: Response @@ -115920,7 +116010,7 @@ paths: application/json: schema: type: array - items: &816 + items: &817 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115988,7 +116078,7 @@ paths: - account - plan examples: - default: &817 + default: &818 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116050,9 +116140,9 @@ paths: application/json: schema: type: array - items: *816 + items: *817 examples: - default: *817 + default: *818 headers: Link: *43 '304': *37 @@ -117047,7 +117137,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *371 - - *818 + - *819 responses: '204': description: Response @@ -117162,7 +117252,7 @@ paths: - docker - nuget - container - - *819 + - *820 - *19 - *17 responses: @@ -117174,8 +117264,8 @@ paths: type: array items: *376 examples: - default: *820 - '400': *821 + default: *821 + '400': *822 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117204,7 +117294,7 @@ paths: application/json: schema: *376 examples: - default: &837 + default: &838 value: id: 40201 name: octo-name @@ -117566,9 +117656,9 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: - default: *822 + default: *823 headers: Link: *43 '304': *37 @@ -117681,7 +117771,7 @@ paths: type: array items: *74 examples: - default: &829 + default: &830 summary: Default response value: - id: 1296269 @@ -117985,9 +118075,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -118025,9 +118115,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: *823 + default: *824 headers: Link: *43 '304': *37 @@ -118106,7 +118196,7 @@ paths: application/json: schema: type: array - items: &824 + items: &825 title: Social account description: Social media account type: object @@ -118121,7 +118211,7 @@ paths: - provider - url examples: - default: &825 + default: &826 value: - provider: twitter url: https://twitter.com/github @@ -118183,9 +118273,9 @@ paths: application/json: schema: type: array - items: *824 + items: *825 examples: - default: *825 + default: *826 '422': *15 '304': *37 '404': *6 @@ -118272,7 +118362,7 @@ paths: application/json: schema: type: array - items: &826 + items: &827 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118292,7 +118382,7 @@ paths: - title - created_at examples: - default: &841 + default: &842 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118356,9 +118446,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *827 examples: - default: &827 + default: &828 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118388,7 +118478,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: - - &828 + - &829 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118400,9 +118490,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *827 examples: - default: *827 + default: *828 '404': *6 '304': *37 '403': *29 @@ -118425,7 +118515,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: - - *828 + - *829 responses: '204': description: Response @@ -118454,7 +118544,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: - - &842 + - &843 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 @@ -118479,11 +118569,11 @@ paths: type: array items: *74 examples: - default-response: *829 + default-response: *830 application/vnd.github.v3.star+json: schema: type: array - items: &843 + items: &844 title: Starred Repository description: Starred Repository type: object @@ -118639,8 +118729,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: - - *456 - *457 + - *458 responses: '204': description: Response if this repository is starred by you @@ -118668,8 +118758,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -118693,8 +118783,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -118766,7 +118856,7 @@ paths: application/json: schema: type: array - items: *437 + items: *438 examples: default: value: @@ -118852,10 +118942,10 @@ paths: application/json: schema: oneOf: + - *804 - *803 - - *802 examples: - default-response: &831 + default-response: &832 summary: Default response value: login: octocat @@ -118890,7 +118980,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &832 + response-with-git-hub-plan-information: &833 summary: Response with GitHub plan information value: login: octocat @@ -119012,7 +119102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *830 + - *831 - *17 responses: '200': @@ -119061,11 +119151,11 @@ paths: application/json: schema: oneOf: + - *804 - *803 - - *802 examples: - default-response: *831 - response-with-git-hub-plan-information: *832 + default-response: *832 + response-with-git-hub-plan-information: *833 '404': *6 x-github: githubCloudOnly: false @@ -119115,8 +119205,8 @@ paths: required: - subject_digests examples: - default: *833 - withPredicateType: *834 + default: *834 + withPredicateType: *835 responses: '200': description: Response @@ -119169,7 +119259,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *835 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119374,7 +119464,7 @@ paths: initiator: type: string examples: - default: *507 + default: *508 '201': description: Response content: @@ -119415,7 +119505,7 @@ paths: type: array items: *376 examples: - default: *820 + default: *821 '403': *29 '401': *25 x-github: @@ -119799,9 +119889,9 @@ paths: application/json: schema: type: array - items: *811 + items: *812 examples: - default: *836 + default: *837 headers: Link: *43 x-github: @@ -119905,7 +119995,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *644 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120029,7 +120119,7 @@ paths: - docker - nuget - container - - *819 + - *820 - *138 - *19 - *17 @@ -120042,10 +120132,10 @@ paths: type: array items: *376 examples: - default: *820 + default: *821 '403': *29 '401': *25 - '400': *821 + '400': *822 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120075,7 +120165,7 @@ paths: application/json: schema: *376 examples: - default: *837 + default: *838 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120424,7 +120514,7 @@ paths: type: array items: *398 examples: - default: *838 + default: *839 headers: Link: *43 '304': *37 @@ -120435,6 +120525,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: + - *138 + - *394 + 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: *398 + 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': *37 + '403': *29 + '401': *25 + '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 @@ -120447,7 +120788,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - *394 - - *839 + - *840 - *138 responses: '200': @@ -120456,7 +120797,7 @@ paths: application/json: schema: *398 examples: - default: *840 + default: *841 headers: Link: *43 '304': *37 @@ -120991,9 +121332,9 @@ paths: application/json: schema: type: array - items: *824 + items: *825 examples: - default: *825 + default: *826 headers: Link: *43 x-github: @@ -121023,9 +121364,9 @@ paths: application/json: schema: type: array - items: *826 + items: *827 examples: - default: *841 + default: *842 headers: Link: *43 x-github: @@ -121050,7 +121391,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *138 - - *842 + - *843 - *106 - *17 - *19 @@ -121062,11 +121403,11 @@ paths: schema: anyOf: - type: array - items: *843 + items: *844 - type: array items: *74 examples: - default-response: *829 + default-response: *830 headers: Link: *43 x-github: @@ -121225,7 +121566,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &844 + enterprise: &845 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121283,7 +121624,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &845 + installation: &846 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121302,7 +121643,7 @@ x-webhooks: required: - id - node_id - organization: &846 + organization: &847 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121362,13 +121703,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &847 + repository: &848 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &884 + properties: &885 id: description: Unique identifier of the repository example: 42 @@ -122051,7 +122392,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &885 + required: &886 - archive_url - assignees_url - blobs_url @@ -122202,10 +122543,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -122281,11 +122622,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: &848 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + rule: &849 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) @@ -122508,11 +122849,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + rule: *849 sender: *4 required: - action @@ -122695,11 +123036,11 @@ x-webhooks: - everyone required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + rule: *849 sender: *4 required: - action @@ -122772,7 +123113,7 @@ x-webhooks: required: true content: application/json: - schema: &868 + schema: &869 title: Exemption request cancellation event type: object properties: @@ -122780,11 +123121,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: &849 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: &850 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123017,7 +123358,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &850 + items: &851 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123127,7 +123468,7 @@ x-webhooks: required: true content: application/json: - schema: &869 + schema: &870 title: Exemption request completed event type: object properties: @@ -123135,11 +123476,11 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 sender: *4 required: - action @@ -123211,7 +123552,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &867 title: Exemption request created event type: object properties: @@ -123219,11 +123560,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 sender: *4 required: - action @@ -123295,7 +123636,7 @@ x-webhooks: required: true content: application/json: - schema: &870 + schema: &871 title: Exemption response dismissed event type: object properties: @@ -123303,12 +123644,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 + exemption_response: *851 sender: *4 required: - action @@ -123382,7 +123723,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &868 title: Exemption response submitted event type: object properties: @@ -123390,12 +123731,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 + exemption_response: *851 sender: *4 required: - action @@ -123479,7 +123820,7 @@ x-webhooks: type: string enum: - completed - check_run: &852 + check_run: &853 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123532,7 +123873,7 @@ x-webhooks: type: string pull_requests: type: array - items: *524 + items: *525 repository: *274 status: example: completed @@ -123570,7 +123911,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *851 + deployment: *852 details_url: example: https://example.com type: string @@ -123620,7 +123961,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *524 + items: *525 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -123655,10 +123996,10 @@ x-webhooks: - output - app - pull_requests - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 sender: *4 required: - check_run @@ -124051,11 +124392,11 @@ x-webhooks: type: string enum: - created - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *853 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 sender: *4 required: - check_run @@ -124451,11 +124792,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *853 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 requested_action: description: The action requested by the user. type: object @@ -124860,11 +125201,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *853 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 sender: *4 required: - check_run @@ -125841,10 +126182,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -126117,6 +126458,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -126529,10 +126875,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -126800,6 +127146,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -127211,10 +127562,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -127380,7 +127731,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127525,20 +127876,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &853 + commit_oid: &854 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: *844 - installation: *845 - organization: *846 - ref: &854 + enterprise: *845 + installation: *846 + organization: *847 + ref: &855 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: *847 + repository: *848 sender: *4 required: - action @@ -127703,7 +128054,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127933,12 +128284,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -128033,7 +128384,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128204,12 +128555,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -128375,7 +128726,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128541,12 +128892,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -128646,7 +128997,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128814,16 +129165,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 ref: 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 nullable: true - repository: *847 + repository: *848 sender: *4 required: - action @@ -128920,7 +129271,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129060,12 +129411,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -129322,10 +129673,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -129405,18 +129756,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *846 - pusher_type: &855 + organization: *847 + pusher_type: &856 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &856 + ref: &857 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -129426,7 +129777,7 @@ x-webhooks: enum: - tag - branch - repository: *847 + repository: *848 sender: *4 required: - ref @@ -129509,9 +129860,9 @@ x-webhooks: enum: - created definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129596,9 +129947,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129676,9 +130027,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129756,9 +130107,9 @@ x-webhooks: enum: - updated definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129835,10 +130186,10 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - repository: *847 - organization: *846 + enterprise: *845 + installation: *846 + repository: *848 + organization: *847 sender: *4 new_property_values: type: array @@ -129923,18 +130274,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - pusher_type: *855 - ref: *856 + enterprise: *845 + installation: *846 + organization: *847 + pusher_type: *856 + ref: *857 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *847 + repository: *848 sender: *4 required: - ref @@ -130018,11 +130369,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130106,11 +130457,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130194,11 +130545,11 @@ x-webhooks: type: string enum: - created - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130280,11 +130631,11 @@ x-webhooks: type: string enum: - dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130366,11 +130717,11 @@ x-webhooks: type: string enum: - fixed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130453,11 +130804,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130539,11 +130890,11 @@ x-webhooks: type: string enum: - reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130620,9 +130971,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - key: &857 + enterprise: *845 + installation: *846 + key: &858 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130658,8 +131009,8 @@ x-webhooks: - verified - created_at - read_only - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -130736,11 +131087,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - key: *857 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + key: *858 + organization: *847 + repository: *848 sender: *4 required: - action @@ -131301,12 +131652,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: &861 + workflow: &862 title: Workflow type: object nullable: true @@ -132032,13 +132383,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *599 + deployment: *600 pull_requests: type: array - items: *695 - repository: *847 - organization: *846 - installation: *845 + items: *696 + repository: *848 + organization: *847 + installation: *846 sender: *4 responses: '200': @@ -132109,7 +132460,7 @@ x-webhooks: type: string enum: - approved - approver: &858 + approver: &859 type: object properties: avatar_url: @@ -132152,11 +132503,11 @@ x-webhooks: type: string comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: &859 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + reviewers: &860 type: array items: type: object @@ -132235,7 +132586,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &860 + workflow_job_run: &861 type: object properties: conclusion: @@ -132966,18 +133317,18 @@ x-webhooks: type: string enum: - rejected - approver: *858 + approver: *859 comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: *859 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + reviewers: *860 sender: *4 since: type: string - workflow_job_run: *860 + workflow_job_run: *861 workflow_job_runs: type: array items: @@ -133681,13 +134032,13 @@ x-webhooks: type: string enum: - requested - enterprise: *844 + enterprise: *845 environment: type: string - installation: *845 - organization: *846 - repository: *847 - requestor: &871 + installation: *846 + organization: *847 + repository: *848 + requestor: &872 title: User type: object nullable: true @@ -135586,12 +135937,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Deployment Workflow Run type: object @@ -136271,7 +136622,7 @@ x-webhooks: type: string enum: - answered - answer: &864 + answer: &865 type: object properties: author_association: @@ -136428,7 +136779,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &862 + discussion: &863 title: Discussion description: A Discussion in a repository. type: object @@ -136714,7 +137065,7 @@ x-webhooks: - id labels: type: array - items: *657 + items: *658 required: - repository_url - category @@ -136736,10 +137087,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -136866,11 +137217,11 @@ x-webhooks: - from required: - category - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -136953,11 +137304,11 @@ x-webhooks: type: string enum: - closed - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137039,7 +137390,7 @@ x-webhooks: type: string enum: - created - comment: &863 + comment: &864 type: object properties: author_association: @@ -137196,11 +137547,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137283,12 +137634,12 @@ x-webhooks: type: string enum: - deleted - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *864 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137383,12 +137734,12 @@ x-webhooks: - from required: - body - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *864 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137472,11 +137823,11 @@ x-webhooks: type: string enum: - created - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137558,11 +137909,11 @@ x-webhooks: type: string enum: - deleted - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137662,11 +138013,11 @@ x-webhooks: type: string required: - from - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137748,10 +138099,10 @@ x-webhooks: type: string enum: - labeled - discussion: *862 - enterprise: *844 - installation: *845 - label: &865 + discussion: *863 + enterprise: *845 + installation: *846 + label: &866 title: Label type: object properties: @@ -137783,8 +138134,8 @@ x-webhooks: - color - default - description - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137867,11 +138218,11 @@ x-webhooks: type: string enum: - locked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137953,11 +138304,11 @@ x-webhooks: type: string enum: - pinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138039,11 +138390,11 @@ x-webhooks: type: string enum: - reopened - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138128,16 +138479,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *862 - new_repository: *847 + new_discussion: *863 + new_repository: *848 required: - new_discussion - new_repository - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138220,10 +138571,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *862 - old_answer: *864 - organization: *846 - repository: *847 + discussion: *863 + old_answer: *865 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138305,12 +138656,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *862 - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138393,11 +138744,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138479,11 +138830,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138552,7 +138903,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138615,7 +138966,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138681,7 +139032,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138747,7 +139098,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *870 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138813,7 +139164,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138879,7 +139230,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *871 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138945,7 +139296,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138971,71 +139322,6 @@ x-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: *868 - 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 @@ -139088,6 +139374,71 @@ x-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: *870 + 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: |- @@ -139140,7 +139491,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139205,7 +139556,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *871 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139271,7 +139622,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139338,7 +139689,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *844 + enterprise: *845 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -139998,9 +140349,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - forkee @@ -140146,9 +140497,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pages: description: The pages that were updated. type: array @@ -140185,7 +140536,7 @@ x-webhooks: - action - sha - html_url - repository: *847 + repository: *848 sender: *4 required: - pages @@ -140261,10 +140612,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: &872 + organization: *847 + repositories: &873 description: An array of repository objects that the installation can access. type: array @@ -140290,8 +140641,8 @@ x-webhooks: - name - full_name - private - repository: *847 - requester: *871 + repository: *848 + requester: *872 sender: *4 required: - action @@ -140366,11 +140717,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -140446,11 +140797,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -140526,10 +140877,10 @@ x-webhooks: type: string enum: - added - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories_added: &873 + organization: *847 + repositories_added: &874 description: An array of repository objects, which were added to the installation. type: array @@ -140575,15 +140926,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *847 - repository_selection: &874 + repository: *848 + repository_selection: &875 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *871 + requester: *872 sender: *4 required: - action @@ -140662,10 +141013,10 @@ x-webhooks: type: string enum: - removed - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories_added: *873 + organization: *847 + repositories_added: *874 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140692,9 +141043,9 @@ x-webhooks: - name - full_name - private - repository: *847 - repository_selection: *874 - requester: *871 + repository: *848 + repository_selection: *875 + requester: *872 sender: *4 required: - action @@ -140773,11 +141124,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -140956,10 +141307,10 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 target_type: type: string @@ -141038,11 +141389,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -141294,8 +141645,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142089,8 +142440,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142439,8 +142790,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -142520,7 +142871,7 @@ x-webhooks: type: string enum: - deleted - comment: &875 + comment: &876 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -142685,8 +143036,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143476,8 +143827,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143828,8 +144179,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -143909,7 +144260,7 @@ x-webhooks: type: string enum: - edited - changes: &904 + changes: &905 description: The changes to the comment. type: object properties: @@ -143921,9 +144272,9 @@ x-webhooks: type: string required: - from - comment: *875 - enterprise: *844 - installation: *845 + comment: *876 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144716,8 +145067,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145066,8 +145417,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145157,9 +145508,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145253,9 +145604,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145348,9 +145699,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145444,9 +145795,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145531,10 +145882,10 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - issue: &878 + assignee: *872 + enterprise: *845 + installation: *846 + issue: &879 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146323,11 +146674,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146444,8 +146795,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -146525,8 +146876,8 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147320,11 +147671,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147576,8 +147927,8 @@ x-webhooks: required: - state - closed_at - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -147656,8 +148007,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148442,11 +148793,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148562,8 +148913,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -148642,8 +148993,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149450,11 +149801,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149549,7 +149900,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &876 + milestone: &877 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149687,8 +150038,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -149787,8 +150138,8 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150577,11 +150928,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150698,9 +151049,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -150780,8 +151131,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151569,11 +151920,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151690,9 +152041,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -151772,8 +152123,8 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152585,11 +152936,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152683,8 +153034,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -152763,8 +153114,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153570,11 +153921,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153668,9 +154019,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *876 - organization: *846 - repository: *847 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -154538,11 +154889,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155104,8 +155455,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155894,11 +156245,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156014,8 +156365,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -156095,9 +156446,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *844 - installation: *845 - issue: &877 + enterprise: *845 + installation: *846 + issue: &878 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -156880,11 +157231,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157000,8 +157351,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -157080,8 +157431,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157891,11 +158242,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157990,8 +158341,8 @@ x-webhooks: user_view_type: type: string type: *360 - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -158857,11 +159208,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159445,11 +159796,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *878 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159529,12 +159880,12 @@ x-webhooks: type: string enum: - typed - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *845 + installation: *846 + issue: *879 type: *360 - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159615,7 +159966,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &907 + assignee: &908 title: User type: object nullable: true @@ -159685,11 +160036,11 @@ x-webhooks: required: - login - id - enterprise: *844 - installation: *845 - issue: *878 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *879 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159768,12 +160119,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - issue: *878 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *879 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159853,8 +160204,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -160664,11 +161015,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160762,8 +161113,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -160843,11 +161194,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *878 + organization: *847 + repository: *848 sender: *4 required: - action @@ -160926,12 +161277,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *845 + installation: *846 + issue: *879 type: *360 - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161011,11 +161362,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161093,11 +161444,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161207,11 +161558,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161293,9 +161644,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: &879 + enterprise: *845 + installation: *846 + marketplace_purchase: &880 title: Marketplace Purchase type: object required: @@ -161378,8 +161729,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: &880 + organization: *847 + previous_marketplace_purchase: &881 title: Marketplace Purchase type: object properties: @@ -161459,7 +161810,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *848 sender: *4 required: - action @@ -161539,10 +161890,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *845 + installation: *846 + marketplace_purchase: *880 + organization: *847 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161625,7 +161976,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *848 sender: *4 required: - action @@ -161707,10 +162058,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *845 + installation: *846 + marketplace_purchase: *880 + organization: *847 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161792,7 +162143,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *848 sender: *4 required: - action @@ -161873,8 +162224,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 marketplace_purchase: title: Marketplace Purchase type: object @@ -161956,9 +162307,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + organization: *847 + previous_marketplace_purchase: *881 + repository: *848 sender: *4 required: - action @@ -162038,12 +162389,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + enterprise: *845 + installation: *846 + marketplace_purchase: *880 + organization: *847 + previous_marketplace_purchase: *881 + repository: *848 sender: *4 required: - action @@ -162145,11 +162496,11 @@ x-webhooks: type: string required: - to - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162249,11 +162600,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162332,11 +162683,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162414,11 +162765,11 @@ x-webhooks: type: string enum: - added - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162494,7 +162845,7 @@ x-webhooks: required: - login - id - team: &881 + team: &882 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162717,11 +163068,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162798,7 +163149,7 @@ x-webhooks: required: - login - id - team: *881 + team: *882 required: - action - scope @@ -162880,8 +163231,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *845 - merge_group: &883 + installation: *846 + merge_group: &884 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162900,15 +163251,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *882 + head_commit: *883 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162994,10 +163345,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *845 - merge_group: *883 - organization: *846 - repository: *847 + installation: *846 + merge_group: *884 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163070,7 +163421,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *845 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163179,16 +163530,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *845 - organization: *846 + installation: *846 + organization: *847 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -163269,11 +163620,11 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163352,9 +163703,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - milestone: &886 + enterprise: *845 + installation: *846 + milestone: &887 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163491,8 +163842,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163571,11 +163922,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163685,11 +164036,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163769,11 +164120,11 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - milestone: *886 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *887 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163852,11 +164203,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *872 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163935,11 +164286,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *872 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164015,7 +164366,7 @@ x-webhooks: enum: - created definition: *146 - enterprise: *844 + enterprise: *845 sender: *4 required: - action @@ -164095,8 +164446,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 sender: *4 required: - action @@ -164169,8 +164520,8 @@ x-webhooks: enum: - updated definition: *146 - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 sender: *4 required: - action @@ -164242,9 +164593,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 new_property_values: type: array @@ -164332,9 +164683,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - membership: &887 + enterprise: *845 + installation: *846 + membership: &888 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164441,8 +164792,8 @@ x-webhooks: - role - organization_url - user - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164520,11 +164871,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + membership: *888 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164603,8 +164954,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164720,10 +165071,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 - user: *871 + user: *872 required: - action - invitation @@ -164801,11 +165152,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + membership: *888 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164892,11 +165243,11 @@ x-webhooks: properties: from: type: string - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + membership: *888 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164972,9 +165323,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 package: description: Information about the package. type: object @@ -165473,7 +165824,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &889 title: Ruby Gems metadata type: object properties: @@ -165568,7 +165919,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -165644,9 +165995,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 package: description: Information about the package. type: object @@ -165999,7 +166350,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *889 source_url: type: string format: uri @@ -166069,7 +166420,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -166246,12 +166597,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *844 + enterprise: *845 id: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - id @@ -166328,7 +166679,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &890 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166474,10 +166825,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *844 - organization: *846 + enterprise: *845 + organization: *847 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166554,11 +166905,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *890 + enterprise: *845 + organization: *847 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166634,11 +166985,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *890 + enterprise: *845 + organization: *847 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166713,11 +167064,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *846 - enterprise: *844 + personal_access_token_request: *890 + organization: *847 + enterprise: *845 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166822,7 +167173,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *891 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166854,8 +167205,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 zen: description: Random string of GitHub zen. @@ -167100,10 +167451,10 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: &891 + enterprise: *845 + installation: *846 + organization: *847 + project_card: &892 title: Project Card type: object properties: @@ -167222,7 +167573,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *848 sender: *4 required: - action @@ -167303,11 +167654,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_card: *892 + repository: *848 sender: *4 required: - action @@ -167387,9 +167738,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 project_card: title: Project Card type: object @@ -167517,8 +167868,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -167612,11 +167963,11 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_card: *892 + repository: *848 sender: *4 required: - action @@ -167710,9 +168061,9 @@ x-webhooks: - from required: - column_id - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 project_card: allOf: - title: Project Card @@ -167902,7 +168253,7 @@ x-webhooks: type: string required: - after_id - repository: *847 + repository: *848 sender: *4 required: - action @@ -167982,10 +168333,10 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - organization: *846 - project: &893 + enterprise: *845 + installation: *846 + organization: *847 + project: &894 title: Project type: object properties: @@ -168109,7 +168460,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *848 sender: *4 required: - action @@ -168189,10 +168540,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_column: &892 + enterprise: *845 + installation: *846 + organization: *847 + project_column: &893 title: Project Column type: object properties: @@ -168231,7 +168582,7 @@ x-webhooks: - name - created_at - updated_at - repository: *847 + repository: *848 sender: *4 required: - action @@ -168310,18 +168661,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 + enterprise: *845 + installation: *846 + organization: *847 + project_column: *893 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -168411,11 +168762,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_column: *893 + repository: *848 sender: *4 required: - action @@ -168495,11 +168846,11 @@ x-webhooks: type: string enum: - moved - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_column: *893 + repository: *848 sender: *4 required: - action @@ -168579,11 +168930,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 + repository: *848 sender: *4 required: - action @@ -168663,18 +169014,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project: *893 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -168776,11 +169127,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 + repository: *848 sender: *4 required: - action @@ -168859,11 +169210,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 + repository: *848 sender: *4 required: - action @@ -168944,8 +169295,8 @@ x-webhooks: type: string enum: - closed - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169027,8 +169378,8 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169110,8 +169461,8 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169229,8 +169580,8 @@ x-webhooks: type: string to: type: string - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169314,7 +169665,7 @@ x-webhooks: type: string enum: - archived - changes: &897 + changes: &898 type: object properties: archived_at: @@ -169328,9 +169679,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *845 - organization: *846 - projects_v2_item: &894 + installation: *846 + organization: *847 + projects_v2_item: &895 title: Projects v2 Item description: An item belonging to a project type: object @@ -169465,9 +169816,9 @@ x-webhooks: nullable: true to: type: string - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169549,9 +169900,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169632,9 +169983,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169740,7 +170091,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &895 + - &896 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169762,7 +170113,7 @@ x-webhooks: required: - id - name - - &896 + - &897 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169796,8 +170147,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *895 - *896 + - *897 required: - field_value - type: object @@ -169813,9 +170164,9 @@ x-webhooks: nullable: true required: - body - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169910,9 +170261,9 @@ x-webhooks: to: type: string nullable: true - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169995,10 +170346,10 @@ x-webhooks: type: string enum: - restored - changes: *897 - installation: *845 - organization: *846 - projects_v2_item: *894 + changes: *898 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -170080,8 +170431,8 @@ x-webhooks: type: string enum: - reopened - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -170163,14 +170514,14 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_status_update: &900 + installation: *846 + organization: *847 + projects_v2_status_update: &901 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *898 - required: *899 + properties: *899 + required: *900 sender: *4 required: - action @@ -170251,9 +170602,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *846 + organization: *847 + projects_v2_status_update: *901 sender: *4 required: - action @@ -170389,9 +170740,9 @@ x-webhooks: type: string format: date nullable: true - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *846 + organization: *847 + projects_v2_status_update: *901 sender: *4 required: - action @@ -170462,10 +170813,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - repository @@ -170542,13 +170893,13 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - number: &901 + assignee: *872 + enterprise: *845 + installation: *846 + number: &902 description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -172831,7 +173182,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -172913,11 +173264,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -175195,7 +175546,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *848 sender: *4 required: - action @@ -175277,11 +175628,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -177559,7 +177910,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *848 sender: *4 required: - action @@ -177641,13 +177992,13 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: &902 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: &903 allOf: - - *695 + - *696 - type: object properties: allow_auto_merge: @@ -177709,7 +178060,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *847 + repository: *848 sender: *4 required: - action @@ -177790,12 +178141,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -177875,11 +178226,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: &903 + enterprise: *845 + milestone: *678 + number: *902 + organization: *847 + pull_request: &904 title: Pull Request type: object properties: @@ -180142,7 +180493,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -180221,11 +180572,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -182507,7 +182858,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *847 + repository: *848 sender: *4 required: - action @@ -182631,12 +182982,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -182716,11 +183067,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -184987,7 +185338,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -185067,11 +185418,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + label: *866 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -187353,7 +187704,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -187434,10 +187785,10 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -189717,7 +190068,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -189797,12 +190148,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: *903 - repository: *847 + enterprise: *845 + milestone: *678 + number: *902 + organization: *847 + pull_request: *904 + repository: *848 sender: *4 required: - action @@ -189881,12 +190232,12 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -189967,12 +190318,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -190052,12 +190403,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -190423,9 +190774,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: type: object properties: @@ -192595,7 +192946,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *848 sender: *4 required: - action @@ -192675,7 +193026,7 @@ x-webhooks: type: string enum: - deleted - comment: &905 + comment: &906 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. @@ -192960,9 +193311,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: type: object properties: @@ -195120,7 +195471,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *848 sender: *4 required: - action @@ -195200,11 +195551,11 @@ x-webhooks: type: string enum: - edited - changes: *904 - comment: *905 - enterprise: *844 - installation: *845 - organization: *846 + changes: *905 + comment: *906 + enterprise: *845 + installation: *846 + organization: *847 pull_request: type: object properties: @@ -197365,7 +197716,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *848 sender: *4 required: - action @@ -197446,9 +197797,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -199621,7 +199972,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *848 review: description: The review that was affected. type: object @@ -199868,9 +200219,9 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -201924,8 +202275,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: &906 + repository: *848 + review: &907 description: The review that was affected. type: object properties: @@ -202158,12 +202509,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -204446,7 +204797,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_reviewer: title: User type: object @@ -204530,12 +204881,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -206825,7 +207176,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207017,12 +207368,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -209307,7 +209658,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_reviewer: title: User type: object @@ -209392,12 +209743,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -211673,7 +212024,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211854,9 +212205,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -214031,8 +214382,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: *906 + repository: *848 + review: *907 sender: *4 required: - action @@ -214112,9 +214463,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -216184,7 +216535,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *848 sender: *4 thread: type: object @@ -216571,9 +216922,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -218629,7 +218980,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *848 sender: *4 thread: type: object @@ -219019,10 +219370,10 @@ x-webhooks: type: string before: type: string - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -221293,7 +221644,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -221375,11 +221726,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *907 - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + assignee: *908 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -223662,7 +224013,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -223741,11 +224092,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + label: *866 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -226018,7 +226369,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -226099,10 +226450,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -228367,7 +228718,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -228567,7 +228918,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *844 + enterprise: *845 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228659,8 +229010,8 @@ x-webhooks: - url - author - committer - installation: *845 - organization: *846 + installation: *846 + organization: *847 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229235,9 +229586,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 registry_package: type: object properties: @@ -229683,7 +230034,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *889 summary: type: string tag_name: @@ -229737,7 +230088,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -229815,9 +230166,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 registry_package: type: object properties: @@ -230125,7 +230476,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *889 summary: type: string tag_name: @@ -230174,7 +230525,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -230251,10 +230602,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - release: &908 + enterprise: *845 + installation: *846 + organization: *847 + release: &909 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -230572,7 +230923,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *847 + repository: *848 sender: *4 required: - action @@ -230649,11 +231000,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *909 + repository: *848 sender: *4 required: - action @@ -230770,11 +231121,11 @@ x-webhooks: type: boolean required: - to - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *909 + repository: *848 sender: *4 required: - action @@ -230852,9 +231203,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231176,7 +231527,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *848 sender: *4 required: - action @@ -231252,10 +231603,10 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - release: &909 + enterprise: *845 + installation: *846 + organization: *847 + release: &910 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231574,7 +231925,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *848 sender: *4 required: - action @@ -231650,11 +232001,11 @@ x-webhooks: type: string enum: - released - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *909 + repository: *848 sender: *4 required: - action @@ -231730,11 +232081,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *844 - installation: *845 - organization: *846 - release: *909 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *910 + repository: *848 sender: *4 required: - action @@ -231810,11 +232161,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + repository_advisory: *749 sender: *4 required: - action @@ -231890,11 +232241,11 @@ x-webhooks: type: string enum: - reported - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + repository_advisory: *749 sender: *4 required: - action @@ -231970,10 +232321,10 @@ x-webhooks: type: string enum: - archived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232050,10 +232401,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232131,10 +232482,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232218,10 +232569,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232333,10 +232684,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232408,10 +232759,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 status: type: string @@ -232492,10 +232843,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232572,10 +232923,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232669,10 +233020,10 @@ x-webhooks: - name required: - repository - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232752,10 +233103,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 repository_ruleset: *185 sender: *4 required: @@ -232834,10 +233185,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 repository_ruleset: *185 sender: *4 required: @@ -232916,10 +233267,10 @@ x-webhooks: type: string enum: - edited - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 repository_ruleset: *185 changes: type: object @@ -232981,16 +233332,16 @@ x-webhooks: properties: added: type: array - items: *716 + items: *717 deleted: type: array - items: *716 + items: *717 updated: type: array items: type: object properties: - rule: *716 + rule: *717 changes: type: object properties: @@ -233224,10 +233575,10 @@ x-webhooks: - from required: - owner - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233305,10 +233656,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233386,7 +233737,7 @@ x-webhooks: type: string enum: - create - alert: &910 + alert: &911 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233507,10 +233858,10 @@ x-webhooks: type: string enum: - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233716,10 +234067,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233797,11 +234148,11 @@ x-webhooks: type: string enum: - reopen - alert: *910 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *911 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234000,10 +234351,10 @@ x-webhooks: enum: - fixed - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234021,7 +234372,7 @@ x-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. @@ -234029,8 +234380,8 @@ x-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: @@ -234074,14 +234425,14 @@ x-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: &911 + - assigned + alert: &912 type: object properties: number: *123 @@ -234199,10 +234550,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + assignee: *4 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + 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: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234283,11 +234717,11 @@ x-webhooks: type: string enum: - created - alert: *911 - installation: *845 - location: *912 - organization: *846 - repository: *847 + alert: *912 + installation: *846 + location: *913 + organization: *847 + repository: *848 sender: *4 required: - location @@ -234525,11 +234959,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234607,11 +235041,11 @@ x-webhooks: type: string enum: - reopened - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234689,11 +235123,94 @@ x-webhooks: type: string enum: - resolved - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + 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: *912 + assignee: *4 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234771,11 +235288,11 @@ x-webhooks: type: string enum: - validated - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234901,10 +235418,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *847 - enterprise: *844 - installation: *845 - organization: *846 + repository: *848 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -234982,11 +235499,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: &913 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + security_advisory: &914 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235169,11 +235686,11 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: *913 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + security_advisory: *914 sender: *4 required: - action @@ -235246,10 +235763,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235434,10 +235951,10 @@ x-webhooks: type: object properties: security_and_analysis: *408 - enterprise: *844 - installation: *845 - organization: *846 - repository: *467 + enterprise: *845 + installation: *846 + organization: *847 + repository: *468 sender: *4 required: - changes @@ -235515,12 +236032,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: &914 + sponsorship: &915 type: object properties: created_at: @@ -235821,12 +236338,12 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - sponsorship @@ -235914,12 +236431,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - changes @@ -235996,17 +236513,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &915 + effective_date: &916 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: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - sponsorship @@ -236080,7 +236597,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &916 + changes: &917 type: object properties: tier: @@ -236124,13 +236641,13 @@ x-webhooks: - from required: - tier - effective_date: *915 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + effective_date: *916 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - changes @@ -236207,13 +236724,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *916 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + changes: *917 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - changes @@ -236287,10 +236804,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236373,10 +236890,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236796,15 +237313,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *844 + enterprise: *845 id: description: The unique identifier of the status. type: integer - installation: *845 + installation: *846 name: type: string - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 sha: description: The Commit SHA. @@ -236919,9 +237436,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237011,9 +237528,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237103,9 +237620,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237195,9 +237712,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237274,12 +237791,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - team: &917 + team: &918 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237502,9 +238019,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -237962,7 +238479,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -238038,9 +238555,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -238498,7 +239015,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -238575,9 +239092,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -239035,7 +239552,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -239179,9 +239696,9 @@ x-webhooks: - from required: - permissions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -239639,7 +240156,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - changes @@ -239717,9 +240234,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -240177,7 +240694,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -240253,10 +240770,10 @@ x-webhooks: type: string enum: - started - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -240329,16 +240846,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *844 + enterprise: *845 inputs: type: object nullable: true additionalProperties: true - installation: *845 - organization: *846 + installation: *846 + organization: *847 ref: type: string - repository: *847 + repository: *848 sender: *4 workflow: type: string @@ -240420,10 +240937,10 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: allOf: @@ -240660,7 +241177,7 @@ x-webhooks: type: string required: - conclusion - deployment: *599 + deployment: *600 required: - action - repository @@ -240739,10 +241256,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: allOf: @@ -241002,7 +241519,7 @@ x-webhooks: required: - status - steps - deployment: *599 + deployment: *600 required: - action - repository @@ -241081,10 +241598,10 @@ x-webhooks: type: string enum: - queued - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: type: object @@ -241219,7 +241736,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *600 required: - action - repository @@ -241298,10 +241815,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: type: object @@ -241437,7 +241954,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *600 required: - action - repository @@ -241517,12 +242034,12 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Workflow Run type: object @@ -242521,12 +243038,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Workflow Run type: object @@ -243510,12 +244027,12 @@ x-webhooks: type: string enum: - requested - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index cf7f65190..1cde416c3 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -4734,6 +4734,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.", @@ -5735,6 +5743,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.", @@ -6590,6 +6606,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.", @@ -7076,6 +7100,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.", @@ -9117,6 +9149,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.", @@ -10169,6 +10209,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.", @@ -11138,6 +11186,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.", @@ -11818,6 +11874,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.", @@ -27409,6 +27473,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.", @@ -28205,6 +28277,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.", @@ -29157,6 +29237,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.", @@ -30500,6 +30588,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.", @@ -59354,6 +59450,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.", @@ -63078,7 +63197,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" + ] + } + } } } } @@ -151668,6 +151802,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.", @@ -152684,6 +152826,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.", @@ -189145,21 +189295,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", @@ -218162,6 +218330,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.", @@ -277562,6 +277753,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -277582,6 +277774,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295780,6 +295973,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295800,6 +295994,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333647,6 +333842,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333667,6 +333863,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339401,6 +339598,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339421,6 +339619,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344754,6 +344953,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344774,6 +344974,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345300,6 +345501,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345320,6 +345522,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345870,6 +346073,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345890,6 +346094,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -381848,6 +382053,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.", @@ -464232,6 +464445,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -464252,6 +464466,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495105,6 +495320,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495125,6 +495341,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -526189,6 +526406,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.", @@ -528429,7 +528669,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" @@ -528499,6 +528739,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -528506,6 +528751,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -528515,6 +528765,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -529491,7 +529753,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 + } } } } @@ -529505,7 +529787,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", @@ -566791,6 +567073,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -567003,6 +567286,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -608846,6 +609130,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.", @@ -657687,6 +657979,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.", @@ -664124,51 +664424,720 @@ "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { @@ -664369,21 +665338,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", @@ -724616,6 +725603,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -726997,6 +727991,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -858270,6 +859271,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.", @@ -860878,6 +861887,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.", @@ -863393,6 +864410,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.", @@ -865908,6 +866933,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.", @@ -868555,6 +869588,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.", @@ -871209,6 +872250,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.", @@ -875486,6 +876535,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.", @@ -1272142,200 +1273199,3589 @@ "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1273843,7 +1278289,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1273859,23 +1278305,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": [ { @@ -1273940,15 +1278384,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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).\"", @@ -1275455,6 +1280075,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1275470,21 +1280091,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" }, @@ -1275551,13 +1280170,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": { @@ -1277256,11 +1281875,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" }, @@ -1277327,13 +1281946,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": { @@ -1277344,9 +1281963,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1277366,10 +1281982,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1277465,9 +1282077,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1277507,7 +1282116,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1279014,279 +1283624,855 @@ "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": { + "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, + "nullable": 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", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1280795,8 +1285981,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1280810,21 +1285995,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": [ { @@ -1280889,179 +1286075,630 @@ "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": { + "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, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1282572,8 +1288209,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1282587,21 +1288223,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": [ { @@ -1282666,7 +1288303,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1283293,74 +1288930,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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1283382,6 +1288951,314 @@ "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.", + "example": "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", + "example": "/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", + "example": "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", + "example": "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", + "example": "/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", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", + "example": "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.", @@ -1284798,10 +1290675,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" + } + } } } } @@ -1284813,8 +1290865,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1284823,13 +1290876,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": [ { @@ -1284894,13 +1290947,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": { @@ -1285521,6 +1291574,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1285542,314 +1291663,6 @@ "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.", - "example": "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", - "example": "/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", - "example": "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", - "example": "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", - "example": "/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", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", - "example": "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.", @@ -1287266,185 +1293079,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" - } - } } } } @@ -1287456,9 +1293094,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1287467,11 +1293104,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" }, @@ -1287538,13 +1293175,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": { @@ -1289695,11 +1295332,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" }, @@ -1289766,13 +1295403,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": { @@ -1291923,11 +1297560,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" }, @@ -1291994,13 +1297631,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": { @@ -1292621,6 +1298258,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index e891ea64d..1d9b1ff4d 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -865,7 +865,7 @@ paths: - subscriptions_url - type - url - type: &428 + type: &429 type: string description: The type of credit the user is receiving. enum: @@ -1031,7 +1031,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: - - &750 + - &751 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1715,7 +1715,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &761 title: Scim Error description: Scim Error type: object @@ -2217,6 +2217,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 @@ -8740,7 +8747,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &762 description: Authorization failure '404': *6 x-github: @@ -12943,7 +12950,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &535 + instances_url: &536 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12978,7 +12985,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &536 + dismissed_reason: &537 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12987,13 +12994,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &537 + dismissed_comment: &538 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &538 + rule: &539 type: object properties: id: @@ -13046,7 +13053,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &539 + tool: &540 type: object properties: name: *107 @@ -13056,15 +13063,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *108 - most_recent_instance: &540 + most_recent_instance: &541 type: object properties: - ref: &533 + ref: &534 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &550 + analysis_key: &551 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13075,7 +13082,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &552 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -16764,7 +16771,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 - - &590 + - &591 name: has in: query description: |- @@ -16877,7 +16884,7 @@ paths: - unknown - direct - transitive - security_advisory: &591 + security_advisory: &592 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17109,7 +17116,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: &592 + auto_dismissed_at: &593 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -18247,7 +18254,7 @@ paths: - name - created_on examples: - default: &433 + default: &434 value: total_count: 2 network_configurations: @@ -18470,7 +18477,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: - *41 - - &434 + - &435 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18482,7 +18489,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &436 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18516,7 +18523,7 @@ paths: - subnet_id - region examples: - default: &436 + default: &437 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -20522,7 +20529,7 @@ paths: - *160 rules: type: array - items: &716 + items: &717 title: Repository Rule type: object description: A repository rule. @@ -20531,7 +20538,7 @@ paths: - *166 - *167 - *168 - - &713 + - &714 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20625,7 +20632,7 @@ paths: - *182 - *183 - *184 - - &714 + - &715 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21020,6 +21027,25 @@ paths: schema: type: string - &419 + 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 + - &420 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. @@ -21035,7 +21061,7 @@ paths: - *17 - *104 - *105 - - &420 + - &421 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21044,7 +21070,7 @@ paths: required: false schema: type: string - - &421 + - &422 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21053,7 +21079,7 @@ paths: schema: type: boolean default: false - - &422 + - &423 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21062,7 +21088,7 @@ paths: schema: type: boolean default: false - - &423 + - &424 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21078,7 +21104,7 @@ paths: application/json: schema: type: array - items: &424 + items: &425 type: object properties: number: *123 @@ -21097,14 +21123,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &728 + state: &729 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: &729 + resolution: &730 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21211,8 +21237,8 @@ paths: pull request. ' - oneOf: &730 - - &732 + oneOf: &731 + - &733 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21264,7 +21290,7 @@ paths: - blob_url - commit_sha - commit_url - - &733 + - &734 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. @@ -21319,7 +21345,7 @@ paths: - page_url - commit_sha - commit_url - - &734 + - &735 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21333,7 +21359,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &735 + - &736 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21347,7 +21373,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &736 + - &737 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21361,7 +21387,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &737 + - &738 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21375,7 +21401,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &738 + - &739 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21389,7 +21415,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &739 + - &740 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21403,7 +21429,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &740 + - &741 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. @@ -21417,7 +21443,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &741 + - &742 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. @@ -21431,7 +21457,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &742 + - &743 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. @@ -21445,7 +21471,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &743 + - &744 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. @@ -21459,7 +21485,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &744 + - &745 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. @@ -21486,7 +21512,7 @@ paths: required: *21 nullable: true examples: - default: &425 + default: &426 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21695,7 +21721,7 @@ paths: description: Response content: application/json: - schema: &426 + schema: &427 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -21778,7 +21804,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &427 + default: &428 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21914,7 +21940,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &430 + - &431 name: advanced_security_product in: query description: | @@ -21934,7 +21960,7 @@ paths: description: Success content: application/json: - schema: &431 + schema: &432 type: object properties: total_advanced_security_committers: @@ -21989,7 +22015,7 @@ paths: required: - repositories examples: - default: &432 + default: &433 value: total_advanced_security_committers: 2 total_count: 2 @@ -22615,7 +22641,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': *25 '403': *29 @@ -24702,7 +24740,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &650 + properties: &651 id: type: integer format: int64 @@ -25074,7 +25112,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &789 title: Sub-issues Summary type: object properties: @@ -25094,7 +25132,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &789 + issue_dependencies_summary: &790 title: Issue Dependencies Summary type: object properties: @@ -25113,7 +25151,7 @@ paths: - total_blocking issue_field_values: type: array - items: &790 + items: &791 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25173,7 +25211,7 @@ paths: - node_id - data_type - value - required: &651 + required: &652 - assignee - closed_at - comments @@ -25194,7 +25232,7 @@ paths: - user - created_at - updated_at - comment: &648 + comment: &649 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25752,7 +25790,7 @@ paths: url: type: string format: uri - user: &802 + user: &803 title: Public User description: Public User type: object @@ -29057,14 +29095,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: - - &456 + - &457 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &457 + - &458 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29126,7 +29164,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &468 + '301': &469 description: Moved permanently content: application/json: @@ -29148,7 +29186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &680 + - &681 name: all description: If `true`, show notifications marked as read. in: query @@ -29156,7 +29194,7 @@ paths: schema: type: boolean default: false - - &681 + - &682 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29166,7 +29204,7 @@ paths: type: boolean default: false - *217 - - &682 + - &683 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: @@ -29648,7 +29686,7 @@ paths: - url - subscription_url examples: - default: &683 + default: &684 value: - id: '1' repository: @@ -30619,7 +30657,7 @@ paths: type: array items: *151 examples: - default: &689 + default: &690 value: - property_name: environment value: production @@ -30669,7 +30707,7 @@ paths: required: - properties examples: - default: &690 + default: &691 value: properties: - property_name: environment @@ -31482,7 +31520,7 @@ paths: type: integer repository_cache_usages: type: array - items: &473 + items: &474 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -33596,7 +33634,7 @@ paths: type: array items: *274 examples: - default: &805 + default: &806 value: total_count: 1 repositories: @@ -34638,7 +34676,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &494 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34667,7 +34705,7 @@ paths: - key_id - key examples: - default: &494 + default: &495 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35080,7 +35118,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *83 - - &478 + - &479 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)." @@ -36262,12 +36300,12 @@ paths: required: - subject_digests examples: - default: &833 + default: &834 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &834 + withPredicateType: &835 value: subject_digests: - sha256:abc123 @@ -36325,7 +36363,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &835 + default: &836 value: attestations_subject_digests: - sha256:abc: @@ -36674,7 +36712,7 @@ paths: initiator: type: string examples: - default: &507 + default: &508 value: attestations: - bundle: @@ -37591,7 +37629,7 @@ paths: be returned. in: query required: false - schema: &534 + schema: &535 type: string description: Severity of a code scanning alert. enum: @@ -38637,7 +38675,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &563 + properties: &564 name: type: string description: The name of the machine. @@ -38679,7 +38717,7 @@ paths: - ready - in_progress nullable: true - required: &564 + required: &565 - name - display_name - operating_system @@ -39547,7 +39585,7 @@ paths: - updated_at - visibility examples: - default: &565 + default: &566 value: total_count: 2 secrets: @@ -39585,7 +39623,7 @@ paths: description: Response content: application/json: - schema: &566 + schema: &567 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39614,7 +39652,7 @@ paths: - key_id - key examples: - default: &567 + default: &568 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39646,7 +39684,7 @@ paths: application/json: schema: *318 examples: - default: &569 + default: &570 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -41355,7 +41393,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &596 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41372,7 +41410,7 @@ paths: - key_id - key examples: - default: &596 + default: &597 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41702,7 +41740,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - &604 + - &605 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41710,7 +41748,7 @@ paths: required: false schema: type: string - - &605 + - &606 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41718,7 +41756,7 @@ paths: required: false schema: type: string - - &606 + - &607 name: time_period description: |- The time period to filter by. @@ -41734,7 +41772,7 @@ paths: - week - month default: month - - &607 + - &608 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41759,7 +41797,7 @@ paths: application/json: schema: type: array - items: &608 + items: &609 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41915,7 +41953,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &609 + default: &610 value: - id: 21 number: 42 @@ -42006,7 +42044,7 @@ paths: - *99 - *100 - *101 - - &610 + - &611 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42032,7 +42070,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42153,7 +42191,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &612 + default: &613 value: - id: 21 number: 42 @@ -42498,7 +42536,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &452 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -42579,7 +42617,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &452 + default: &453 value: group_id: '123' group_name: Octocat admins @@ -42634,7 +42672,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &450 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42671,7 +42709,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &450 + default: &451 value: groups: - group_id: '123' @@ -43973,7 +44011,7 @@ paths: application/json: schema: *22 examples: - default: &643 + default: &644 value: id: 1 account: @@ -44198,7 +44236,7 @@ paths: required: true content: application/json: - schema: &644 + schema: &645 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -45059,7 +45097,7 @@ paths: application/json: schema: *365 examples: - default: &562 + default: &563 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -46304,7 +46342,7 @@ paths: parameters: - *83 - *371 - - &818 + - &819 name: repo_name description: repo_name parameter in: path @@ -47336,7 +47374,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &429 + items: &430 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -47630,7 +47668,7 @@ paths: - nuget - container - *83 - - &819 + - &820 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47671,7 +47709,7 @@ paths: default: *377 '403': *29 '401': *25 - '400': &821 + '400': &822 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -49463,7 +49501,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &898 + properties: &899 id: type: number description: The unique identifier of the status update. @@ -49511,7 +49549,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &899 + required: &900 - id - node_id - created_at @@ -49725,7 +49763,7 @@ paths: content: oneOf: - *227 - - &577 + - &578 title: Pull Request Simple description: Pull Request Simple type: object @@ -49954,7 +49992,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: &692 + auto_merge: &693 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50329,7 +50367,7 @@ paths: - updated_at - project_url examples: - default: &838 + default: &839 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50461,7 +50499,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - *394 - - &839 + - &840 name: field_id description: The unique identifier of the field. in: path @@ -50476,7 +50514,7 @@ paths: application/json: schema: *398 examples: - default: &840 + default: &841 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50485,17 +50523,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: @@ -52251,7 +52301,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &468 title: Full Repository description: Full Repository type: object @@ -52644,7 +52694,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &582 + properties: &583 url: type: string format: uri @@ -52660,7 +52710,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &583 + required: &584 - url - key - name @@ -52749,7 +52799,7 @@ paths: - network_count - subscribers_count examples: - default: &469 + default: &470 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -53302,7 +53352,7 @@ paths: - *83 - *17 - *19 - - &715 + - &716 name: targets description: | A comma-separated list of rule targets to filter by. @@ -53516,7 +53566,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *83 - - &717 + - &718 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 @@ -53528,14 +53578,14 @@ paths: x-multi-segment: true - *300 - *101 - - &718 + - &719 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 - - &719 + - &720 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53555,7 +53605,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &721 title: Rule Suites description: Response type: array @@ -53610,7 +53660,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &721 + default: &722 value: - id: 21 actor_id: 12 @@ -53654,7 +53704,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *83 - - &722 + - &723 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53670,7 +53720,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &724 title: Rule Suite description: Response type: object @@ -53769,7 +53819,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &724 + default: &725 value: id: 21 actor_id: 12 @@ -54097,10 +54147,11 @@ paths: - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - &726 + - &727 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 @@ -54110,7 +54161,7 @@ paths: required: false schema: type: string - - &727 + - &728 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 @@ -54120,10 +54171,10 @@ paths: required: false schema: type: string - - *420 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -54131,9 +54182,9 @@ paths: application/json: schema: type: array - items: *424 + items: *425 examples: - default: *425 + default: *426 headers: Link: *43 '404': *6 @@ -54168,9 +54219,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *427 examples: - default: *427 + default: *428 '403': *29 '404': *6 patch: @@ -54323,7 +54374,7 @@ paths: application/json: schema: type: array - items: &748 + items: &749 description: A repository security advisory. type: object properties: @@ -54543,7 +54594,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 credits_detailed: type: array nullable: true @@ -54553,7 +54604,7 @@ paths: type: object properties: user: *4 - type: *428 + type: *429 state: type: string description: The state of the user's acceptance of the @@ -54614,7 +54665,7 @@ paths: - private_fork additionalProperties: false examples: - default: &749 + default: &750 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55001,7 +55052,7 @@ paths: application/json: schema: type: array - items: *429 + items: *430 examples: default: *375 x-github: @@ -55085,7 +55136,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *83 - - *430 + - *431 - *17 - *19 responses: @@ -55093,9 +55144,9 @@ paths: description: Success content: application/json: - schema: *431 + schema: *432 examples: - default: *432 + default: *433 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55376,7 +55427,7 @@ paths: type: array items: *143 examples: - default: *433 + default: *434 headers: Link: *43 x-github: @@ -55577,15 +55628,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: - *83 - - *434 + - *435 responses: '200': description: Response content: application/json: - schema: *435 + schema: *436 examples: - default: *436 + default: *437 headers: Link: *43 x-github: @@ -55623,7 +55674,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &459 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55669,7 +55720,7 @@ paths: type: string nullable: true examples: - default: &459 + default: &460 value: groups: - group_id: '123' @@ -55877,7 +55928,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &438 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56204,7 +56255,7 @@ paths: - repos_count - organization examples: - default: &438 + default: &439 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56281,9 +56332,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -56367,16 +56418,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -56446,7 +56497,7 @@ paths: application/json: schema: type: array - items: &439 + items: &440 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56545,7 +56596,7 @@ paths: - updated_at - url examples: - default: &792 + default: &793 value: - author: login: octocat @@ -56654,9 +56705,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &440 + default: &441 value: author: login: octocat @@ -56730,7 +56781,7 @@ paths: parameters: - *83 - *210 - - &441 + - &442 name: discussion_number description: The number that identifies the discussion. in: path @@ -56742,9 +56793,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56768,7 +56819,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: false content: @@ -56791,9 +56842,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: &793 + default: &794 value: author: login: octocat @@ -56865,7 +56916,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 responses: '204': description: Response @@ -56893,7 +56944,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - *106 - *17 - *19 @@ -56904,7 +56955,7 @@ paths: application/json: schema: type: array - items: &442 + items: &443 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56976,7 +57027,7 @@ paths: - updated_at - url examples: - default: &794 + default: &795 value: - author: login: octocat @@ -57046,7 +57097,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57068,9 +57119,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &443 + default: &444 value: author: login: octocat @@ -57138,8 +57189,8 @@ paths: parameters: - *83 - *210 - - *441 - - &444 + - *442 + - &445 name: comment_number description: The number that identifies the comment. in: path @@ -57151,9 +57202,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57177,8 +57228,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57200,9 +57251,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: &795 + default: &796 value: author: login: octocat @@ -57268,8 +57319,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 responses: '204': description: Response @@ -57297,8 +57348,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 - 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. @@ -57324,7 +57375,7 @@ paths: application/json: schema: type: array - items: &445 + items: &446 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57367,7 +57418,7 @@ paths: - content - created_at examples: - default: &447 + default: &448 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57419,8 +57470,8 @@ paths: parameters: - *83 - *210 - - *441 - - *444 + - *442 + - *445 requestBody: required: true content: @@ -57453,9 +57504,9 @@ paths: team discussion comment content: application/json: - schema: *445 + schema: *446 examples: - default: &446 + default: &447 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57484,9 +57535,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57511,9 +57562,9 @@ paths: parameters: - *83 - *210 - - *441 - - *444 - - &448 + - *442 + - *445 + - &449 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57547,7 +57598,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 - 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. @@ -57573,9 +57624,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -57603,7 +57654,7 @@ paths: parameters: - *83 - *210 - - *441 + - *442 requestBody: required: true content: @@ -57635,16 +57686,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57669,8 +57720,8 @@ paths: parameters: - *83 - *210 - - *441 - - *448 + - *442 + - *449 responses: '204': description: Response @@ -57700,9 +57751,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *450 examples: - default: *450 + default: *451 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57745,9 +57796,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *452 examples: - default: *452 + default: *453 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57888,7 +57939,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &454 title: Team Membership description: Team Membership type: object @@ -57915,7 +57966,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &796 + response-if-user-is-a-team-maintainer: &797 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57978,9 +58029,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: &797 + response-if-users-membership-with-team-is-now-pending: &798 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -58053,7 +58104,7 @@ paths: application/json: schema: type: array - items: &454 + items: &455 title: Team Project description: A team's access to a project. type: object @@ -58121,7 +58172,7 @@ paths: - updated_at - permissions examples: - default: &798 + default: &799 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -58186,7 +58237,7 @@ paths: parameters: - *83 - *210 - - &455 + - &456 name: project_id description: The unique identifier of the project. in: path @@ -58198,9 +58249,9 @@ paths: description: Response content: application/json: - schema: *454 + schema: *455 examples: - default: &799 + default: &800 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -58264,7 +58315,7 @@ paths: parameters: - *83 - *210 - - *455 + - *456 requestBody: required: false content: @@ -58332,7 +58383,7 @@ paths: parameters: - *83 - *210 - - *455 + - *456 responses: '204': description: Response @@ -58403,14 +58454,14 @@ paths: parameters: - *83 - *210 - - *456 - *457 + - *458 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &800 + schema: &801 title: Team Repository description: A team's access to a repository. type: object @@ -58981,8 +59032,8 @@ paths: parameters: - *83 - *210 - - *456 - *457 + - *458 requestBody: required: false content: @@ -59029,8 +59080,8 @@ paths: parameters: - *83 - *210 - - *456 - *457 + - *458 responses: '204': description: Response @@ -59063,9 +59114,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *459 examples: - default: *459 + default: *460 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59131,7 +59182,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *459 examples: default: value: @@ -59176,7 +59227,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: &801 + response-if-child-teams-exist: &802 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -59303,7 +59354,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &460 + - &461 name: card_id description: The unique identifier of the card. in: path @@ -59315,7 +59366,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &462 title: Project Card description: Project cards represent a scope of work. type: object @@ -59382,7 +59433,7 @@ paths: - created_at - updated_at examples: - default: &462 + default: &463 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -59438,7 +59489,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *460 + - *461 requestBody: required: false content: @@ -59465,9 +59516,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *462 + default: *463 '304': *37 '403': *29 '401': *25 @@ -59494,7 +59545,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *460 + - *461 responses: '204': description: Response @@ -59538,7 +59589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *460 + - *461 requestBody: required: true content: @@ -59649,7 +59700,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &463 + - &464 name: column_id description: The unique identifier of the column. in: path @@ -59661,7 +59712,7 @@ paths: description: Response content: application/json: - schema: &464 + schema: &465 title: Project Column description: Project columns contain cards of work. type: object @@ -59707,7 +59758,7 @@ paths: - created_at - updated_at examples: - default: &465 + default: &466 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -59742,7 +59793,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *463 + - *464 requestBody: required: true content: @@ -59766,9 +59817,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *465 examples: - default: *465 + default: *466 '304': *37 '403': *29 '401': *25 @@ -59793,7 +59844,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *463 + - *464 responses: '204': description: Response @@ -59822,7 +59873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *463 + - *464 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -59843,7 +59894,7 @@ paths: application/json: schema: type: array - items: *461 + items: *462 examples: default: value: @@ -59902,7 +59953,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *463 + - *464 requestBody: required: true content: @@ -59942,9 +59993,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *462 + default: *463 '304': *37 '403': *29 '401': *25 @@ -60000,7 +60051,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *463 + - *464 requestBody: required: true content: @@ -60060,7 +60111,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *455 + - *456 - 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 @@ -60117,7 +60168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *455 + - *456 - *138 requestBody: required: false @@ -60170,7 +60221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *455 + - *456 - *138 responses: '204': @@ -60202,7 +60253,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: - - *455 + - *456 - *138 responses: '200': @@ -60303,7 +60354,7 @@ paths: resources: type: object properties: - core: &466 + core: &467 title: Rate Limit type: object properties: @@ -60320,21 +60371,21 @@ paths: - remaining - reset - used - graphql: *466 - search: *466 - code_search: *466 - source_import: *466 - integration_manifest: *466 - code_scanning_upload: *466 - actions_runner_registration: *466 - scim: *466 - dependency_snapshots: *466 - dependency_sbom: *466 - code_scanning_autofix: *466 + graphql: *467 + search: *467 + code_search: *467 + source_import: *467 + integration_manifest: *467 + code_scanning_upload: *467 + actions_runner_registration: *467 + scim: *467 + dependency_snapshots: *467 + dependency_sbom: *467 + code_scanning_autofix: *467 required: - core - search - rate: *466 + rate: *467 required: - rate - resources @@ -60439,14 +60490,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: default-response: summary: Default response @@ -60951,7 +61002,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *468 + '301': *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60969,8 +61020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -61227,10 +61278,10 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 - '307': &470 + default: *470 + '307': &471 description: Temporary Redirect content: application/json: @@ -61259,8 +61310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -61282,7 +61333,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': *470 + '307': *471 '404': *6 '409': *114 x-github: @@ -61306,11 +61357,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 - - &485 + - &486 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61333,7 +61384,7 @@ paths: type: integer artifacts: type: array - items: &471 + items: &472 title: Artifact description: An artifact type: object @@ -61411,7 +61462,7 @@ paths: - expires_at - updated_at examples: - default: &486 + default: &487 value: total_count: 2 artifacts: @@ -61472,9 +61523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *456 - *457 - - &472 + - *458 + - &473 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61486,7 +61537,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *472 examples: default: value: @@ -61524,9 +61575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *456 - *457 - - *472 + - *458 + - *473 responses: '204': description: Response @@ -61550,9 +61601,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *456 - *457 - - *472 + - *458 + - *473 - name: archive_format in: path required: true @@ -61566,7 +61617,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': &647 + '410': &648 description: Gone content: application/json: @@ -61593,14 +61644,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: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *473 + schema: *474 examples: default: value: @@ -61626,11 +61677,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: - - *456 - *457 + - *458 - *17 - *19 - - &474 + - &475 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 @@ -61664,7 +61715,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &476 title: Repository actions caches description: Repository actions caches type: object @@ -61706,7 +61757,7 @@ paths: - total_count - actions_caches examples: - default: &476 + default: &477 value: total_count: 1 actions_caches: @@ -61738,23 +61789,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: - - *456 - *457 + - *458 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *474 + - *475 responses: '200': description: Response content: application/json: - schema: *475 + schema: *476 examples: - default: *476 + default: *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61774,8 +61825,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: - - *456 - *457 + - *458 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61806,9 +61857,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: - - *456 - *457 - - &477 + - *458 + - &478 name: job_id description: The unique identifier of the job. in: path @@ -61820,7 +61871,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &490 title: Job description: Information of a job execution in a workflow run type: object @@ -62127,9 +62178,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: - - *456 - *457 - - *477 + - *458 + - *478 responses: '302': description: Response @@ -62157,9 +62208,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: - - *456 - *457 - - *477 + - *458 + - *478 requestBody: required: false content: @@ -62204,8 +62255,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: - - *456 - *457 + - *458 responses: '200': description: Status response @@ -62255,8 +62306,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -62319,8 +62370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -62338,7 +62389,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &492 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62358,7 +62409,7 @@ paths: - created_at - updated_at examples: - default: &492 + default: &493 value: total_count: 2 secrets: @@ -62391,9 +62442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *456 - *457 - - *478 + - *458 + - *479 - *19 responses: '200': @@ -62410,7 +62461,7 @@ paths: type: integer variables: type: array - items: &495 + items: &496 title: Actions Variable type: object properties: @@ -62440,7 +62491,7 @@ paths: - created_at - updated_at examples: - default: &496 + default: &497 value: total_count: 2 variables: @@ -62473,8 +62524,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62483,7 +62534,7 @@ paths: schema: type: object properties: - enabled: &479 + enabled: &480 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *56 @@ -62518,8 +62569,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -62530,7 +62581,7 @@ paths: schema: type: object properties: - enabled: *479 + enabled: *480 allowed_actions: *56 sha_pinning_required: *57 required: @@ -62563,14 +62614,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: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: &480 + schema: &481 type: object properties: access_level: @@ -62588,7 +62639,7 @@ paths: required: - access_level examples: - default: &481 + default: &482 value: access_level: organization x-github: @@ -62613,15 +62664,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: - - *456 - *457 + - *458 requestBody: required: true content: application/json: - schema: *480 + schema: *481 examples: - default: *481 + default: *482 responses: '204': description: Response @@ -62645,8 +62696,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62676,8 +62727,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: - - *456 - *457 + - *458 responses: '204': description: Empty response for successful settings update @@ -62711,8 +62762,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62739,8 +62790,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -62774,8 +62825,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62803,8 +62854,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -62835,8 +62886,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62867,8 +62918,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -62900,8 +62951,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -62930,8 +62981,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: - - *456 - *457 + - *458 responses: '204': description: Success response @@ -62971,8 +63022,8 @@ paths: in: query schema: type: string - - *456 - *457 + - *458 - *17 - *19 responses: @@ -63016,8 +63067,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -63049,8 +63100,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -63124,8 +63175,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: - - *456 - *457 + - *458 responses: '201': description: Response @@ -63161,8 +63212,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: - - *456 - *457 + - *458 responses: '201': description: Response @@ -63192,8 +63243,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: - - *456 - *457 + - *458 - *71 responses: '200': @@ -63223,8 +63274,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: - - *456 - *457 + - *458 - *71 responses: '204': @@ -63251,8 +63302,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: - - *456 - *457 + - *458 - *71 responses: '200': *77 @@ -63277,8 +63328,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: - - *456 - *457 + - *458 - *71 requestBody: required: true @@ -63327,8 +63378,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: - - *456 - *457 + - *458 - *71 requestBody: required: true @@ -63378,8 +63429,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: - - *456 - *457 + - *458 - *71 responses: '200': *281 @@ -63409,8 +63460,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: - - *456 - *457 + - *458 - *71 - *282 responses: @@ -63440,9 +63491,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: - - *456 - *457 - - &499 + - *458 + - &500 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. @@ -63450,7 +63501,7 @@ paths: required: false schema: type: string - - &500 + - &501 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63458,7 +63509,7 @@ paths: required: false schema: type: string - - &501 + - &502 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63467,7 +63518,7 @@ paths: required: false schema: type: string - - &502 + - &503 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 @@ -63494,7 +63545,7 @@ paths: - pending - *17 - *19 - - &503 + - &504 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)." @@ -63503,7 +63554,7 @@ paths: schema: type: string format: date-time - - &482 + - &483 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63512,13 +63563,13 @@ paths: schema: type: boolean default: false - - &504 + - &505 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &505 + - &506 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63541,7 +63592,7 @@ paths: type: integer workflow_runs: type: array - items: &483 + items: &484 title: Workflow Run description: An invocation of a workflow type: object @@ -63636,7 +63687,7 @@ paths: that triggered the run. type: array nullable: true - items: &524 + items: &525 title: Pull Request Minimal type: object properties: @@ -63755,7 +63806,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &528 + properties: &529 id: type: string description: SHA for the commit @@ -63806,7 +63857,7 @@ paths: - name - email nullable: true - required: &529 + required: &530 - id - tree_id - message @@ -63853,7 +63904,7 @@ paths: - workflow_url - pull_requests examples: - default: &506 + default: &507 value: total_count: 1 workflow_runs: @@ -64089,24 +64140,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *456 - *457 - - &484 + - *458 + - &485 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *482 + - *483 responses: '200': description: Response content: application/json: - schema: *483 + schema: *484 examples: - default: &487 + default: &488 value: id: 30433642 name: Build @@ -64347,9 +64398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '204': description: Response @@ -64372,9 +64423,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: - - *456 - *457 - - *484 + - *458 + - *485 responses: '200': description: Response @@ -64493,9 +64544,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: - - *456 - *457 - - *484 + - *458 + - *485 responses: '201': description: Response @@ -64528,12 +64579,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *456 - *457 - - *484 + - *458 + - *485 - *17 - *19 - - *485 + - *486 responses: '200': description: Response @@ -64549,9 +64600,9 @@ paths: type: integer artifacts: type: array - items: *471 + items: *472 examples: - default: *486 + default: *487 headers: Link: *43 x-github: @@ -64575,25 +64626,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *456 - *457 - - *484 - - &488 + - *458 + - *485 + - &489 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *482 + - *483 responses: '200': description: Response content: application/json: - schema: *483 + schema: *484 examples: - default: *487 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64616,10 +64667,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: - - *456 - *457 - - *484 - - *488 + - *458 + - *485 + - *489 - *17 - *19 responses: @@ -64637,9 +64688,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *490 examples: - default: &490 + default: &491 value: total_count: 1 jobs: @@ -64752,10 +64803,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *456 - *457 - - *484 - - *488 + - *458 + - *485 + - *489 responses: '302': description: Response @@ -64783,9 +64834,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '202': description: Response @@ -64818,9 +64869,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: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: true content: @@ -64887,9 +64938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '202': description: Response @@ -64922,9 +64973,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: - - *456 - *457 - - *484 + - *458 + - *485 - 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 @@ -64954,9 +65005,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *490 examples: - default: *490 + default: *491 headers: Link: *43 x-github: @@ -64981,9 +65032,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '302': description: Response @@ -65010,9 +65061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '204': description: Response @@ -65039,9 +65090,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: - - *456 - *457 - - *484 + - *458 + - *485 responses: '200': description: Response @@ -65101,7 +65152,7 @@ paths: items: type: object properties: - type: &613 + type: &614 type: string description: The type of reviewer. enum: @@ -65186,9 +65237,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: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: true content: @@ -65235,7 +65286,7 @@ paths: application/json: schema: type: array - items: &599 + items: &600 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65341,7 +65392,7 @@ paths: - created_at - updated_at examples: - default: &600 + default: &601 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65397,9 +65448,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: false content: @@ -65443,9 +65494,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: - - *456 - *457 - - *484 + - *458 + - *485 requestBody: required: false content: @@ -65499,9 +65550,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *456 - *457 - - *484 + - *458 + - *485 responses: '200': description: Response @@ -65638,8 +65689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -65657,9 +65708,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *492 examples: - default: *492 + default: *493 headers: Link: *43 x-github: @@ -65684,16 +65735,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *493 + schema: *494 examples: - default: *494 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65715,17 +65766,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *492 examples: - default: &626 + default: &627 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65751,8 +65802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 requestBody: required: true @@ -65810,8 +65861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '204': @@ -65837,9 +65888,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *456 - *457 - - *478 + - *458 + - *479 - *19 responses: '200': @@ -65856,9 +65907,9 @@ paths: type: integer variables: type: array - items: *495 + items: *496 examples: - default: *496 + default: *497 headers: Link: *43 x-github: @@ -65881,8 +65932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -65934,17 +65985,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *456 - *457 + - *458 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: &627 + default: &628 value: name: USERNAME value: octocat @@ -65970,8 +66021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *456 - *457 + - *458 - *287 requestBody: required: true @@ -66014,8 +66065,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *456 - *457 + - *458 - *287 responses: '204': @@ -66041,8 +66092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -66060,7 +66111,7 @@ paths: type: integer workflows: type: array - items: &497 + items: &498 title: Workflow description: A GitHub Actions workflow type: object @@ -66167,9 +66218,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *456 - *457 - - &498 + - *458 + - &499 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66184,7 +66235,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *498 examples: default: value: @@ -66217,9 +66268,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '204': description: Response @@ -66244,9 +66295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '204': description: Response @@ -66297,9 +66348,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '204': description: Response @@ -66326,19 +66377,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: - - *456 - *457 - - *498 + - *458 - *499 - *500 - *501 - *502 + - *503 - *17 - *19 - - *503 - - *482 - *504 + - *483 - *505 + - *506 responses: '200': description: Response @@ -66354,9 +66405,9 @@ paths: type: integer workflow_runs: type: array - items: *483 + items: *484 examples: - default: *506 + default: *507 headers: Link: *43 x-github: @@ -66389,9 +66440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *456 - *457 - - *498 + - *458 + - *499 responses: '200': description: Response @@ -66452,8 +66503,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *456 - *457 + - *458 - *106 - *17 - *104 @@ -66617,8 +66668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -66655,8 +66706,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: - - *456 - *457 + - *458 - name: assignee in: path required: true @@ -66692,8 +66743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -66805,8 +66856,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *456 - *457 + - *458 - *17 - *104 - *105 @@ -66863,7 +66914,7 @@ paths: initiator: type: string examples: - default: *507 + default: *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66883,8 +66934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -66892,7 +66943,7 @@ paths: application/json: schema: type: array - items: &508 + items: &509 title: Autolink reference description: An autolink reference. type: object @@ -66946,8 +66997,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -66986,9 +67037,9 @@ paths: description: response content: application/json: - schema: *508 + schema: *509 examples: - default: &509 + default: &510 value: id: 1 key_prefix: TICKET- @@ -67019,9 +67070,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: - - *456 - *457 - - &510 + - *458 + - &511 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67033,9 +67084,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *509 examples: - default: *509 + default: *510 '404': *6 x-github: githubCloudOnly: false @@ -67055,9 +67106,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: - - *456 - *457 - - *510 + - *458 + - *511 responses: '204': description: Response @@ -67081,8 +67132,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: - - *456 - *457 + - *458 responses: '200': description: Response if Dependabot is enabled @@ -67130,8 +67181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -67152,8 +67203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -67173,8 +67224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *456 - *457 + - *458 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67212,7 +67263,7 @@ paths: - url protected: type: boolean - protection: &512 + protection: &513 title: Branch Protection description: Branch Protection type: object @@ -67254,7 +67305,7 @@ paths: required: - contexts - checks - enforce_admins: &515 + enforce_admins: &516 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67269,7 +67320,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &517 + required_pull_request_reviews: &518 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67345,7 +67396,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &514 + restrictions: &515 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67622,9 +67673,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *456 - *457 - - &513 + - *458 + - &514 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). @@ -67638,14 +67689,14 @@ paths: description: Response content: application/json: - schema: &523 + schema: &524 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &573 + commit: &574 title: Commit description: Commit type: object @@ -67679,7 +67730,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &511 + properties: &512 name: type: string example: '"Chris Wanstrath"' @@ -67688,13 +67739,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *512 nullable: true message: type: string @@ -67715,7 +67767,7 @@ paths: required: - sha - url - verification: &633 + verification: &634 title: Verification type: object properties: @@ -67785,7 +67837,7 @@ paths: type: integer files: type: array - items: &586 + items: &587 title: Diff Entry description: Diff Entry type: object @@ -67869,7 +67921,7 @@ paths: - self protected: type: boolean - protection: *512 + protection: *513 protection_url: type: string format: uri @@ -67976,7 +68028,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *468 + '301': *469 '404': *6 x-github: githubCloudOnly: false @@ -67998,15 +68050,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *512 + schema: *513 examples: default: value: @@ -68200,9 +68252,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -68457,7 +68509,7 @@ paths: url: type: string format: uri - required_status_checks: &520 + required_status_checks: &521 title: Status Check Policy description: Status Check Policy type: object @@ -68609,7 +68661,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *514 + restrictions: *515 required_conversation_resolution: type: object properties: @@ -68721,9 +68773,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -68748,17 +68800,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: &516 + default: &517 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68780,17 +68832,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: *516 + default: *517 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68809,9 +68861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -68836,17 +68888,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: &518 + default: &519 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68942,9 +68994,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69042,9 +69094,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *518 examples: - default: *518 + default: *519 '422': *15 x-github: githubCloudOnly: false @@ -69065,9 +69117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69094,17 +69146,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: &519 + default: &520 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69127,17 +69179,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *515 + schema: *516 examples: - default: *519 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -69157,9 +69209,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69184,17 +69236,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69220,9 +69272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69274,9 +69326,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 '404': *6 '422': *15 x-github: @@ -69298,9 +69350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69324,9 +69376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -69360,9 +69412,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69429,9 +69481,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -69495,9 +69547,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: content: application/json: @@ -69563,15 +69615,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response content: application/json: - schema: *514 + schema: *515 examples: default: value: @@ -69662,9 +69714,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 responses: '204': description: Response @@ -69687,9 +69739,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: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -69699,7 +69751,7 @@ paths: type: array items: *5 examples: - default: &522 + default: &523 value: - id: 1 slug: octoapp @@ -69756,9 +69808,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -69792,7 +69844,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -69813,9 +69865,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -69849,7 +69901,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -69870,9 +69922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -69906,7 +69958,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *523 '422': *15 x-github: githubCloudOnly: false @@ -69928,9 +69980,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: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -69960,9 +70012,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -70021,9 +70073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: false content: @@ -70082,9 +70134,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: content: application/json: @@ -70143,9 +70195,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: - - *456 - *457 - - *513 + - *458 + - *514 responses: '200': description: Response @@ -70179,9 +70231,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70239,9 +70291,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70299,9 +70351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70361,9 +70413,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *456 - *457 - - *513 + - *458 + - *514 requestBody: required: true content: @@ -70385,7 +70437,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *524 examples: default: value: @@ -70499,8 +70551,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - *457 + - *458 - *99 - *100 - *101 @@ -70536,8 +70588,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - *457 + - *458 - name: bypass_request_number in: path required: true @@ -70610,8 +70662,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - *99 - *100 - *101 @@ -70651,8 +70703,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - name: bypass_request_number in: path required: true @@ -70722,8 +70774,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - name: bypass_request_number in: path required: true @@ -70794,8 +70846,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - *457 + - *458 - name: bypass_response_id in: path required: true @@ -70828,8 +70880,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -71108,7 +71160,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &526 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71227,8 +71279,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *524 - deployment: &851 + items: *525 + deployment: &852 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71508,9 +71560,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *456 - *457 - - &526 + - *458 + - &527 name: check_run_id description: The unique identifier of the check run. in: path @@ -71522,9 +71574,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: &527 + default: &528 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71624,9 +71676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *456 - *457 - - *526 + - *458 + - *527 requestBody: required: true content: @@ -71866,9 +71918,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *526 examples: - default: *527 + default: *528 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71888,9 +71940,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *456 - *457 - - *526 + - *458 + - *527 - *17 - *19 responses: @@ -71985,9 +72037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *456 - *457 - - *526 + - *458 + - *527 responses: '201': description: Response @@ -72031,8 +72083,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -72054,7 +72106,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &530 + schema: &531 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72118,7 +72170,7 @@ paths: nullable: true pull_requests: type: array - items: *524 + items: *525 nullable: true app: title: GitHub app @@ -72140,12 +72192,12 @@ paths: type: string format: date-time nullable: true - head_commit: &882 + head_commit: &883 title: Simple Commit description: A commit. type: object - properties: *528 - required: *529 + properties: *529 + required: *530 latest_check_runs_count: type: integer check_runs_url: @@ -72173,7 +72225,7 @@ paths: - check_runs_url - pull_requests examples: - default: &531 + default: &532 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72464,9 +72516,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *530 + schema: *531 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72485,8 +72537,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -72795,9 +72847,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *456 - *457 - - &532 + - *458 + - &533 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72809,9 +72861,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *531 examples: - default: *531 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,17 +72886,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: - - *456 - *457 - - *532 - - &579 + - *458 + - *533 + - &580 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &580 + - &581 name: status description: Returns check runs with the specified `status`. in: query @@ -72883,9 +72935,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *526 examples: - default: &581 + default: &582 value: total_count: 1 check_runs: @@ -72987,9 +73039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *456 - *457 - - *532 + - *458 + - *533 responses: '201': description: Response @@ -73022,21 +73074,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: - - *456 - *457 + - *458 - *307 - *308 - *19 - *17 - - &548 + - &549 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: *533 - - &549 + schema: *534 + - &550 name: pr description: The number of the pull request for the results you want to list. in: query @@ -73067,7 +73119,7 @@ paths: be returned. in: query required: false - schema: *534 + schema: *535 responses: '200': description: Response @@ -73083,7 +73135,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *536 state: *109 fixed_at: *133 dismissed_by: @@ -73094,11 +73146,11 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 - rule: *538 - tool: *539 - most_recent_instance: *540 + dismissed_reason: *537 + dismissed_comment: *538 + rule: *539 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73224,7 +73276,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &541 + '403': &542 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -73251,9 +73303,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: - - *456 - *457 - - &542 + - *458 + - &543 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73267,7 +73319,7 @@ paths: description: Response content: application/json: - schema: &543 + schema: &544 type: object properties: number: *123 @@ -73275,7 +73327,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *535 + instances_url: *536 state: *109 fixed_at: *133 dismissed_by: @@ -73286,8 +73338,8 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *537 + dismissed_comment: *538 rule: type: object properties: @@ -73341,8 +73393,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *539 - most_recent_instance: *540 + tool: *540 + most_recent_instance: *541 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73441,7 +73493,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -73461,9 +73513,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: - - *456 - *457 - - *542 + - *458 + - *543 requestBody: required: true content: @@ -73478,8 +73530,8 @@ paths: enum: - open - dismissed - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *537 + dismissed_comment: *538 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73498,7 +73550,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *544 examples: default: value: @@ -73574,7 +73626,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &547 + '403': &548 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -73601,15 +73653,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: - - *456 - *457 - - *542 + - *458 + - *543 responses: '200': description: Response content: application/json: - schema: &544 + schema: &545 type: object properties: status: @@ -73635,13 +73687,13 @@ paths: - description - started_at examples: - default: &545 + default: &546 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &546 + '400': &547 description: Bad Request content: application/json: @@ -73652,7 +73704,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': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -73677,29 +73729,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: - - *456 - *457 - - *542 + - *458 + - *543 responses: '200': description: OK content: application/json: - schema: *544 + schema: *545 examples: - default: *545 + default: *546 '202': description: Accepted content: application/json: - schema: *544 + schema: *545 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *546 + '400': *547 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73731,9 +73783,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: - - *456 - *457 - - *542 + - *458 + - *543 requestBody: required: false content: @@ -73778,8 +73830,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *546 - '403': *547 + '400': *547 + '403': *548 '404': *6 '422': description: Unprocessable Entity @@ -73803,13 +73855,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: - - *456 - *457 - - *542 + - *458 + - *543 - *19 - *17 - - *548 - *549 + - *550 responses: '200': description: Response @@ -73817,7 +73869,7 @@ paths: application/json: schema: type: array - items: *540 + items: *541 examples: default: value: @@ -73856,7 +73908,7 @@ paths: end_column: 50 classifications: - source - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -73890,25 +73942,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: - - *456 - *457 + - *458 - *307 - *308 - *19 - *17 - - *549 + - *550 - 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: *533 + schema: *534 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &552 + schema: &553 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -73929,23 +73981,23 @@ paths: application/json: schema: type: array - items: &553 + items: &554 type: object properties: - ref: *533 - commit_sha: &561 + ref: *534 + commit_sha: &562 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: *550 + analysis_key: *551 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *552 error: type: string example: error reading field xyz @@ -73969,8 +74021,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *552 - tool: *539 + sarif_id: *553 + tool: *540 deletable: type: boolean warning: @@ -74031,7 +74083,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -74067,8 +74119,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: - - *456 - *457 + - *458 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74081,7 +74133,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *554 examples: response: summary: application/json response @@ -74135,7 +74187,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *541 + '403': *542 '404': *6 '422': description: Response if analysis could not be processed @@ -74222,8 +74274,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: - - *456 - *457 + - *458 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74276,7 +74328,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': *547 + '403': *548 '404': *6 '503': *190 x-github: @@ -74298,8 +74350,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -74307,7 +74359,7 @@ paths: application/json: schema: type: array - items: &554 + items: &555 title: CodeQL Database description: A CodeQL database. type: object @@ -74418,7 +74470,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': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -74447,8 +74499,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: - - *456 - *457 + - *458 - name: language in: path description: The language of the CodeQL database. @@ -74460,7 +74512,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *555 examples: default: value: @@ -74492,9 +74544,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': &588 + '302': &589 description: Found - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -74516,8 +74568,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *456 - *457 + - *458 - name: language in: path description: The language of the CodeQL database. @@ -74527,7 +74579,7 @@ paths: responses: '204': description: Response - '403': *547 + '403': *548 '404': *6 '503': *190 x-github: @@ -74555,8 +74607,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -74565,7 +74617,7 @@ paths: type: object additionalProperties: false properties: - language: &555 + language: &556 type: string description: The language targeted by the CodeQL query enum: @@ -74645,7 +74697,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &559 + schema: &560 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74655,7 +74707,7 @@ paths: description: The ID of the variant analysis. controller_repo: *115 actor: *4 - query_language: *555 + query_language: *556 query_pack_url: type: string description: The download url for the query pack. @@ -74702,7 +74754,7 @@ paths: items: type: object properties: - repository: &556 + repository: &557 title: Repository Identifier description: Repository Identifier type: object @@ -74738,7 +74790,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &560 + analysis_status: &561 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74770,7 +74822,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &557 + access_mismatch_repos: &558 type: object properties: repository_count: @@ -74784,7 +74836,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: *556 + items: *557 required: - repository_count - repositories @@ -74806,8 +74858,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *557 - over_limit_repos: *557 + no_codeql_db_repos: *558 + over_limit_repos: *558 required: - access_mismatch_repos - not_found_repos @@ -74823,7 +74875,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &558 + value: &559 summary: Default response value: id: 1 @@ -74975,10 +75027,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *558 + value: *559 repository_lists: summary: Response for a successful variant analysis submission - value: *558 + value: *559 '404': *6 '422': description: Unable to process variant analysis submission @@ -75006,8 +75058,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: - - *456 - *457 + - *458 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75019,9 +75071,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *560 examples: - default: *558 + default: *559 '404': *6 '503': *190 x-github: @@ -75044,7 +75096,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: - - *456 + - *457 - name: repo in: path description: The name of the controller repository. @@ -75079,7 +75131,7 @@ paths: type: object properties: repository: *115 - analysis_status: *560 + analysis_status: *561 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75204,8 +75256,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -75290,7 +75342,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *541 + '403': *542 '404': *6 '503': *190 x-github: @@ -75311,8 +75363,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -75404,7 +75456,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *547 + '403': *548 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75475,8 +75527,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -75484,7 +75536,7 @@ paths: schema: type: object properties: - commit_sha: *561 + commit_sha: *562 ref: type: string description: |- @@ -75542,7 +75594,7 @@ paths: schema: type: object properties: - id: *552 + id: *553 url: type: string description: The REST API URL for checking the status of the upload. @@ -75556,7 +75608,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': *547 + '403': *548 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -75579,8 +75631,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: - - *456 - *457 + - *458 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75626,7 +75678,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': *541 + '403': *542 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -75651,8 +75703,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -75733,8 +75785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *456 - *457 + - *458 - 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 @@ -75854,8 +75906,8 @@ paths: parameters: - *17 - *19 - - *456 - *457 + - *458 responses: '200': description: Response @@ -76169,8 +76221,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -76235,7 +76287,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -76243,7 +76295,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '400': *14 '401': *25 '403': *29 @@ -76272,8 +76324,8 @@ paths: parameters: - *17 - *19 - - *456 - *457 + - *458 responses: '200': description: Response @@ -76337,8 +76389,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: - - *456 - *457 + - *458 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76373,14 +76425,14 @@ paths: type: integer machines: type: array - items: &808 + items: &809 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *564 + required: *565 examples: - default: &809 + default: &810 value: total_count: 2 machines: @@ -76420,8 +76472,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *456 - *457 + - *458 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76505,8 +76557,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: - - *456 - *457 + - *458 - 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 @@ -76572,8 +76624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -76591,7 +76643,7 @@ paths: type: integer secrets: type: array - items: &568 + items: &569 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76611,7 +76663,7 @@ paths: - created_at - updated_at examples: - default: *565 + default: *566 headers: Link: *43 x-github: @@ -76634,16 +76686,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *566 + schema: *567 examples: - default: *567 + default: *568 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76663,17 +76715,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '200': description: Response content: application/json: - schema: *568 + schema: *569 examples: - default: *569 + default: *570 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76693,8 +76745,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: - - *456 - *457 + - *458 - *284 requestBody: required: true @@ -76747,8 +76799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '204': @@ -76777,8 +76829,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *456 - *457 + - *458 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76820,7 +76872,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &570 + properties: &571 login: type: string example: octocat @@ -76913,7 +76965,7 @@ paths: user_view_type: type: string example: public - required: &571 + required: &572 - avatar_url - events_url - followers_url @@ -76987,8 +77039,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: - - *456 - *457 + - *458 - *138 responses: '204': @@ -77035,8 +77087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *456 - *457 + - *458 - *138 requestBody: required: false @@ -77063,7 +77115,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &646 + schema: &647 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77292,8 +77344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *456 - *457 + - *458 - *138 responses: '204': @@ -77325,8 +77377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *456 - *457 + - *458 - *138 responses: '200': @@ -77347,8 +77399,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *570 - required: *571 + properties: *571 + required: *572 nullable: true required: - permission @@ -77403,8 +77455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -77414,7 +77466,7 @@ paths: application/json: schema: type: array - items: &572 + items: &573 title: Commit Comment description: Commit Comment type: object @@ -77472,7 +77524,7 @@ paths: - created_at - updated_at examples: - default: &575 + default: &576 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77531,17 +77583,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 responses: '200': description: Response content: application/json: - schema: *572 + schema: *573 examples: - default: &576 + default: &577 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77598,8 +77650,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -77622,7 +77674,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: default: value: @@ -77673,8 +77725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 responses: '204': @@ -77696,8 +77748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -77724,9 +77776,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -77747,8 +77799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -77781,16 +77833,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -77812,10 +77864,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *456 - *457 + - *458 - *226 - - *448 + - *449 responses: '204': description: Response @@ -77864,8 +77916,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *456 - *457 + - *458 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77921,9 +77973,9 @@ paths: application/json: schema: type: array - items: *573 + items: *574 examples: - default: &699 + default: &700 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78017,9 +78069,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *456 - *457 - - &574 + - *458 + - &575 name: commit_sha description: The SHA of the commit. in: path @@ -78091,9 +78143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *456 - *457 - - *574 + - *458 + - *575 - *17 - *19 responses: @@ -78103,9 +78155,9 @@ paths: application/json: schema: type: array - items: *572 + items: *573 examples: - default: *575 + default: *576 headers: Link: *43 x-github: @@ -78133,9 +78185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *456 - *457 - - *574 + - *458 + - *575 requestBody: required: true content: @@ -78170,9 +78222,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *573 examples: - default: *576 + default: *577 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78200,9 +78252,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: - - *456 - *457 - - *574 + - *458 + - *575 - *17 - *19 responses: @@ -78212,9 +78264,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: &691 + default: &692 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78751,11 +78803,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *456 - *457 + - *458 - *19 - *17 - - &578 + - &579 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)" @@ -78770,9 +78822,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *574 examples: - default: &676 + default: &677 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78885,11 +78937,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: - - *456 - *457 - - *578 + - *458 - *579 - *580 + - *581 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78923,9 +78975,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *526 examples: - default: *581 + default: *582 headers: Link: *43 x-github: @@ -78950,9 +79002,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: - - *456 - *457 - - *578 + - *458 + - *579 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78960,7 +79012,7 @@ paths: schema: type: integer example: 1 - - *579 + - *580 - *17 - *19 responses: @@ -78978,7 +79030,7 @@ paths: type: integer check_suites: type: array - items: *530 + items: *531 examples: default: value: @@ -79178,9 +79230,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: - - *456 - *457 - - *578 + - *458 + - *579 - *17 - *19 responses: @@ -79378,9 +79430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *456 - *457 - - *578 + - *458 + - *579 - *17 - *19 responses: @@ -79390,7 +79442,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 title: Status description: The status of a commit. type: object @@ -79471,7 +79523,7 @@ paths: site_admin: false headers: Link: *43 - '301': *468 + '301': *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79499,8 +79551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -79529,20 +79581,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *582 - required: *583 + properties: *583 + required: *584 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &584 + properties: &585 url: type: string format: uri html_url: type: string format: uri - required: &585 + required: &586 - url - html_url nullable: true @@ -79556,26 +79608,26 @@ paths: contributing: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true readme: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true issue_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true pull_request_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *585 + required: *586 nullable: true required: - code_of_conduct @@ -79702,8 +79754,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *456 - *457 + - *458 - *19 - *17 - name: basehead @@ -79746,8 +79798,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *573 - merge_base_commit: *573 + base_commit: *574 + merge_base_commit: *574 status: type: string enum: @@ -79767,10 +79819,10 @@ paths: example: 6 commits: type: array - items: *573 + items: *574 files: type: array - items: *586 + items: *587 required: - url - html_url @@ -80056,8 +80108,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *456 - *457 + - *458 - name: path description: path parameter in: path @@ -80200,7 +80252,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &587 + response-if-content-is-a-file: &588 summary: Response if content is a file value: type: file @@ -80332,7 +80384,7 @@ paths: - size - type - url - - &704 + - &705 title: Content File description: Content File type: object @@ -80533,7 +80585,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *587 + response-if-content-is-a-file: *588 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80602,7 +80654,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *588 + '302': *589 '304': *37 x-github: githubCloudOnly: false @@ -80625,8 +80677,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *456 - *457 + - *458 - name: path description: path parameter in: path @@ -80719,7 +80771,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &590 title: File Commit description: File Commit type: object @@ -80871,7 +80923,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: example-for-creating-a-file: value: @@ -80925,7 +80977,7 @@ paths: schema: oneOf: - *3 - - &628 + - &629 description: Repository rule violation was detected type: object properties: @@ -80946,7 +80998,7 @@ paths: items: type: object properties: - placeholder_id: &745 + placeholder_id: &746 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80978,8 +81030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *456 - *457 + - *458 - name: path description: path parameter in: path @@ -81040,7 +81092,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -81095,8 +81147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *456 - *457 + - *458 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81219,8 +81271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *456 - *457 + - *458 - *323 - *324 - *325 @@ -81232,7 +81284,7 @@ paths: schema: type: string - *327 - - *590 + - *591 - *328 - *329 - *106 @@ -81253,7 +81305,7 @@ paths: application/json: schema: type: array - items: &593 + items: &594 type: object description: A Dependabot alert. properties: @@ -81299,7 +81351,7 @@ paths: - unknown - direct - transitive - security_advisory: *591 + security_advisory: *592 security_vulnerability: *127 url: *128 html_url: *129 @@ -81330,7 +81382,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: *592 + auto_dismissed_at: *593 required: - number - state @@ -81560,9 +81612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *456 - *457 - - &594 + - *458 + - &595 name: alert_number in: path description: |- @@ -81577,7 +81629,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: default: value: @@ -81690,9 +81742,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *456 - *457 - - *594 + - *458 + - *595 requestBody: required: true content: @@ -81737,7 +81789,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *594 examples: default: value: @@ -81866,8 +81918,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -81885,7 +81937,7 @@ paths: type: integer secrets: type: array - items: &597 + items: &598 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81938,16 +81990,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *595 + schema: *596 examples: - default: *596 + default: *597 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81967,15 +82019,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '200': description: Response content: application/json: - schema: *597 + schema: *598 examples: default: value: @@ -82001,8 +82053,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 requestBody: required: true @@ -82055,8 +82107,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *456 - *457 + - *458 - *284 responses: '204': @@ -82079,8 +82131,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: - - *456 - *457 + - *458 - 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 @@ -82240,8 +82292,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -82480,8 +82532,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -82556,7 +82608,7 @@ paths: - version - url additionalProperties: false - metadata: &598 + metadata: &599 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82589,7 +82641,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *598 + metadata: *599 resolved: type: object description: A collection of resolved package dependencies. @@ -82602,7 +82654,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *598 + metadata: *599 relationship: type: string description: A notation of whether a dependency is requested @@ -82731,8 +82783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *456 - *457 + - *458 - name: sha description: The SHA recorded at creation time. in: query @@ -82772,9 +82824,9 @@ paths: application/json: schema: type: array - items: *599 + items: *600 examples: - default: *600 + default: *601 headers: Link: *43 x-github: @@ -82840,8 +82892,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -82922,7 +82974,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: simple-example: summary: Simple example @@ -82995,9 +83047,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *456 - *457 - - &601 + - *458 + - &602 name: deployment_id description: deployment_id parameter in: path @@ -83009,7 +83061,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *600 examples: default: value: @@ -83074,9 +83126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *456 - *457 - - *601 + - *458 + - *602 responses: '204': description: Response @@ -83098,9 +83150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *456 - *457 - - *601 + - *458 + - *602 - *17 - *19 responses: @@ -83110,7 +83162,7 @@ paths: application/json: schema: type: array - items: &602 + items: &603 title: Deployment Status description: The status of a deployment. type: object @@ -83271,9 +83323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *456 - *457 - - *601 + - *458 + - *602 requestBody: required: true content: @@ -83348,9 +83400,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: &603 + default: &604 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83406,9 +83458,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *456 - *457 - - *601 + - *458 + - *602 - name: status_id in: path required: true @@ -83419,9 +83471,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *603 examples: - default: *603 + default: *604 '404': *6 x-github: githubCloudOnly: false @@ -83448,12 +83500,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 - - *604 + - *458 - *605 - *606 - *607 + - *608 - *17 - *19 responses: @@ -83463,9 +83515,9 @@ paths: application/json: schema: type: array - items: *608 + items: *609 examples: - default: *609 + default: *610 '404': *6 '403': *29 '500': *40 @@ -83489,8 +83541,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83502,7 +83554,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *608 + schema: *609 examples: default: value: @@ -83558,8 +83610,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83618,12 +83670,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - *99 - *100 - *101 - - *610 + - *611 - *17 - *19 responses: @@ -83633,9 +83685,9 @@ paths: application/json: schema: type: array - items: *611 + items: *612 examples: - default: *612 + default: *613 '404': *6 '403': *29 '500': *40 @@ -83660,8 +83712,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83673,7 +83725,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *611 + schema: *612 examples: default: value: @@ -83731,8 +83783,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - *457 + - *458 - name: alert_number in: path required: true @@ -83801,8 +83853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -83859,8 +83911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -83877,7 +83929,7 @@ paths: type: integer environments: type: array - items: &614 + items: &615 title: Environment description: Details of a deployment environment type: object @@ -83929,7 +83981,7 @@ paths: type: type: string example: wait_timer - wait_timer: &616 + wait_timer: &617 type: integer example: 30 description: The amount of time to delay a job after @@ -83966,7 +84018,7 @@ paths: items: type: object properties: - type: *613 + type: *614 reviewer: anyOf: - *4 @@ -83990,7 +84042,7 @@ paths: - id - node_id - type - deployment_branch_policy: &617 + deployment_branch_policy: &618 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -84106,9 +84158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *456 - *457 - - &615 + - *458 + - &616 name: environment_name in: path required: true @@ -84121,9 +84173,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: &618 + default: &619 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84207,9 +84259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *456 - *457 - - *615 + - *458 + - *616 requestBody: required: false content: @@ -84218,7 +84270,7 @@ paths: type: object nullable: true properties: - wait_timer: *616 + wait_timer: *617 prevent_self_review: type: boolean example: false @@ -84235,13 +84287,13 @@ paths: items: type: object properties: - type: *613 + type: *614 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *617 + deployment_branch_policy: *618 additionalProperties: false examples: default: @@ -84261,9 +84313,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *618 + default: *619 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84287,9 +84339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *456 - *457 - - *615 + - *458 + - *616 responses: '204': description: Default response @@ -84314,9 +84366,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *17 - *19 responses: @@ -84334,7 +84386,7 @@ paths: example: 2 branch_policies: type: array - items: &619 + items: &620 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84391,9 +84443,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 + - *458 + - *616 requestBody: required: true content: @@ -84439,9 +84491,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - example-wildcard: &620 + example-wildcard: &621 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84483,10 +84535,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 - - &621 + - *458 + - *616 + - &622 name: branch_policy_id in: path required: true @@ -84498,9 +84550,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *620 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84519,10 +84571,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 - - *621 + - *458 + - *616 + - *622 requestBody: required: true content: @@ -84550,9 +84602,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *620 examples: - default: *620 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84571,10 +84623,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *456 - *457 - - *615 - - *621 + - *458 + - *616 + - *622 responses: '204': description: Response @@ -84599,9 +84651,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: - - *615 + - *616 + - *458 - *457 - - *456 responses: '200': description: List of deployment protection rules @@ -84617,7 +84669,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &622 + items: &623 title: Deployment protection rule description: Deployment protection rule type: object @@ -84636,7 +84688,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &623 + app: &624 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84735,9 +84787,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: - - *615 + - *616 + - *458 - *457 - - *456 requestBody: content: application/json: @@ -84758,9 +84810,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *622 + schema: *623 examples: - default: &624 + default: &625 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84795,9 +84847,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: - - *615 + - *616 + - *458 - *457 - - *456 - *19 - *17 responses: @@ -84816,7 +84868,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *623 + items: *624 examples: default: value: @@ -84851,10 +84903,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: - - *456 - *457 - - *615 - - &625 + - *458 + - *616 + - &626 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84866,9 +84918,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *623 examples: - default: *624 + default: *625 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84889,10 +84941,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: - - *615 + - *616 + - *458 - *457 - - *456 - - *625 + - *626 responses: '204': description: Response @@ -84918,9 +84970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *17 - *19 responses: @@ -84938,9 +84990,9 @@ paths: type: integer secrets: type: array - items: *491 + items: *492 examples: - default: *492 + default: *493 headers: Link: *43 x-github: @@ -84965,17 +85017,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *456 - *457 - - *615 + - *458 + - *616 responses: '200': description: Response content: application/json: - schema: *493 + schema: *494 examples: - default: *494 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84997,18 +85049,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *284 responses: '200': description: Response content: application/json: - schema: *491 + schema: *492 examples: - default: *626 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85030,9 +85082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *284 requestBody: required: true @@ -85090,9 +85142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *284 responses: '204': @@ -85118,10 +85170,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *456 - *457 - - *615 - - *478 + - *458 + - *616 + - *479 - *19 responses: '200': @@ -85138,9 +85190,9 @@ paths: type: integer variables: type: array - items: *495 + items: *496 examples: - default: *496 + default: *497 headers: Link: *43 x-github: @@ -85163,9 +85215,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *456 - *457 - - *615 + - *458 + - *616 requestBody: required: true content: @@ -85217,18 +85269,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *456 - *457 - - *615 + - *458 + - *616 - *287 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: *627 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85249,10 +85301,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *456 - *457 + - *458 - *287 - - *615 + - *616 requestBody: required: true content: @@ -85294,10 +85346,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *456 - *457 + - *458 - *287 - - *615 + - *616 responses: '204': description: Response @@ -85319,8 +85371,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -85388,8 +85440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *456 - *457 + - *458 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85548,8 +85600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -85581,9 +85633,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 '400': *14 '422': *15 '403': *29 @@ -85604,8 +85656,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -85665,7 +85717,7 @@ paths: schema: oneOf: - *249 - - *628 + - *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85690,8 +85742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *456 - *457 + - *458 - name: file_sha in: path required: true @@ -85790,8 +85842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -85900,7 +85952,7 @@ paths: description: Response content: application/json: - schema: &629 + schema: &630 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86114,15 +86166,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *456 - *457 - - *574 + - *458 + - *575 responses: '200': description: Response content: application/json: - schema: *629 + schema: *630 examples: default: value: @@ -86178,9 +86230,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *456 - *457 - - &630 + - *458 + - &631 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. @@ -86197,7 +86249,7 @@ paths: application/json: schema: type: array - items: &631 + items: &632 title: Git Reference description: Git references within a repository type: object @@ -86272,17 +86324,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *456 - *457 - - *630 + - *458 + - *631 responses: '200': description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: &632 + default: &633 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86311,8 +86363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -86341,9 +86393,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -86369,9 +86421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *456 - *457 - - *630 + - *458 + - *631 requestBody: required: true content: @@ -86400,9 +86452,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 '422': *15 '409': *114 x-github: @@ -86420,9 +86472,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *456 - *457 - - *630 + - *458 + - *631 responses: '204': description: Response @@ -86477,8 +86529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -86545,7 +86597,7 @@ paths: description: Response content: application/json: - schema: &634 + schema: &635 title: Git Tag description: Metadata for a Git tag type: object @@ -86596,7 +86648,7 @@ paths: - sha - type - url - verification: *633 + verification: *634 required: - sha - url @@ -86606,7 +86658,7 @@ paths: - tag - message examples: - default: &635 + default: &636 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86679,8 +86731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *456 - *457 + - *458 - name: tag_sha in: path required: true @@ -86691,9 +86743,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: *635 + default: *636 '404': *6 '409': *114 x-github: @@ -86717,8 +86769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -86791,7 +86843,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &637 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86887,8 +86939,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *456 - *457 + - *458 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86911,7 +86963,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *637 examples: default-response: summary: Default response @@ -86970,8 +87022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -86981,7 +87033,7 @@ paths: application/json: schema: type: array - items: &637 + items: &638 title: Webhook description: Webhooks for repositories. type: object @@ -87035,7 +87087,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &891 title: Hook Response type: object properties: @@ -87109,8 +87161,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -87162,9 +87214,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *638 examples: - default: &638 + default: &639 value: type: Repository id: 12345678 @@ -87212,17 +87264,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '200': description: Response content: application/json: - schema: *637 + schema: *638 examples: - default: *638 + default: *639 '404': *6 x-github: githubCloudOnly: false @@ -87242,8 +87294,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 requestBody: required: true @@ -87289,9 +87341,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *638 examples: - default: *638 + default: *639 '422': *15 '404': *6 x-github: @@ -87312,8 +87364,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '204': @@ -87338,8 +87390,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: - - *456 - *457 + - *458 - *337 responses: '200': @@ -87367,8 +87419,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: - - *456 - *457 + - *458 - *337 requestBody: required: false @@ -87413,8 +87465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 - *17 - *338 @@ -87446,8 +87498,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: - - *456 - *457 + - *458 - *337 - *16 responses: @@ -87476,8 +87528,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: - - *456 - *457 + - *458 - *337 - *16 responses: @@ -87501,8 +87553,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '204': @@ -87528,8 +87580,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *456 - *457 + - *458 - *337 responses: '204': @@ -87553,8 +87605,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: - - *456 - *457 + - *458 responses: '200': description: Response if immutable releases are enabled @@ -87600,8 +87652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *456 - *457 + - *458 responses: '204': *150 '409': *114 @@ -87621,8 +87673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *456 - *457 + - *458 responses: '204': *150 '409': *114 @@ -87679,14 +87731,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: &639 + schema: &640 title: Import description: A repository import from an external source. type: object @@ -87785,7 +87837,7 @@ paths: - html_url - authors_url examples: - default: &642 + default: &643 value: vcs: subversion use_lfs: true @@ -87801,7 +87853,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': &640 + '503': &641 description: Unavailable due to service under maintenance. content: application/json: @@ -87830,8 +87882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -87879,7 +87931,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *640 examples: default: value: @@ -87904,7 +87956,7 @@ paths: type: string '422': *15 '404': *6 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87932,8 +87984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -87982,7 +88034,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *640 examples: example-1: summary: Example 1 @@ -88030,7 +88082,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': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88053,12 +88105,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *456 - *457 + - *458 responses: '204': description: Response - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88084,9 +88136,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *456 - *457 - - &830 + - *458 + - &831 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88100,7 +88152,7 @@ paths: application/json: schema: type: array - items: &641 + items: &642 title: Porter Author description: Porter Author type: object @@ -88154,7 +88206,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': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88179,8 +88231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *456 - *457 + - *458 - name: author_id in: path required: true @@ -88210,7 +88262,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -88223,7 +88275,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88247,8 +88299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -88289,7 +88341,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88317,8 +88369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -88345,11 +88397,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *640 examples: - default: *642 + default: *643 '422': *15 - '503': *640 + '503': *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88372,8 +88424,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -88381,8 +88433,8 @@ paths: application/json: schema: *22 examples: - default: *643 - '301': *468 + default: *644 + '301': *469 '404': *6 x-github: githubCloudOnly: false @@ -88402,8 +88454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -88416,7 +88468,7 @@ paths: properties: {} additionalProperties: false examples: - default: &645 + default: &646 value: limit: collaborators_only origin: repository @@ -88441,13 +88493,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: true content: application/json: - schema: *644 + schema: *645 examples: default: summary: Example request body @@ -88461,7 +88513,7 @@ paths: application/json: schema: *355 examples: - default: *645 + default: *646 '409': description: Response x-github: @@ -88483,8 +88535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -88507,8 +88559,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -88518,9 +88570,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: &823 + default: &824 value: - id: 1 repository: @@ -88651,8 +88703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *456 - *457 + - *458 - *359 requestBody: required: false @@ -88682,7 +88734,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: default: value: @@ -88813,8 +88865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *456 - *457 + - *458 - *359 responses: '204': @@ -88846,8 +88898,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *456 - *457 + - *458 - 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 @@ -88920,7 +88972,7 @@ paths: type: array items: *227 examples: - default: &656 + default: &657 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89068,7 +89120,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *468 + '301': *469 '422': *15 '404': *6 x-github: @@ -89097,8 +89149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -89182,7 +89234,7 @@ paths: application/json: schema: *227 examples: - default: &653 + default: &654 value: id: 1 node_id: MDU6SXNzdWUx @@ -89338,7 +89390,7 @@ paths: '422': *15 '503': *190 '404': *6 - '410': *647 + '410': *648 x-github: triggersNotification: true githubCloudOnly: false @@ -89366,8 +89418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *456 - *457 + - *458 - *237 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -89388,9 +89440,9 @@ paths: application/json: schema: type: array - items: *648 + items: *649 examples: - default: &655 + default: &656 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89448,17 +89500,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 responses: '200': description: Response content: application/json: - schema: *648 + schema: *649 examples: - default: &649 + default: &650 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89512,8 +89564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -89536,9 +89588,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: - default: *649 + default: *650 '422': *15 x-github: githubCloudOnly: false @@ -89556,8 +89608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 responses: '204': @@ -89578,8 +89630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -89606,9 +89658,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -89629,8 +89681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -89663,16 +89715,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -89694,10 +89746,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *456 - *457 + - *458 - *226 - - *448 + - *449 responses: '204': description: Response @@ -89717,8 +89769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -89728,7 +89780,7 @@ paths: application/json: schema: type: array - items: &652 + items: &653 title: Issue Event description: Issue Event type: object @@ -89771,8 +89823,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *650 - required: *651 + properties: *651 + required: *652 nullable: true label: title: Issue Event Label @@ -90079,8 +90131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *456 - *457 + - *458 - name: event_id in: path required: true @@ -90091,7 +90143,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *653 examples: default: value: @@ -90284,7 +90336,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *647 + '410': *648 '403': *29 x-github: githubCloudOnly: false @@ -90318,9 +90370,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *456 - *457 - - &654 + - *458 + - &655 name: issue_number description: The number that identifies the issue. in: path @@ -90334,10 +90386,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *654 + '301': *469 '404': *6 - '410': *647 + '410': *648 '304': *37 x-github: githubCloudOnly: false @@ -90362,9 +90414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -90470,13 +90522,13 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 '422': *15 '503': *190 '403': *29 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90494,9 +90546,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -90524,7 +90576,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90540,9 +90592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: content: application/json: @@ -90569,7 +90621,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90591,9 +90643,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: - - *456 - *457 - - *654 + - *458 + - *655 - name: assignee in: path required: true @@ -90633,9 +90685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *217 - *17 - *19 @@ -90646,13 +90698,13 @@ paths: application/json: schema: type: array - items: *648 + items: *649 examples: - default: *655 + default: *656 headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90681,9 +90733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -90705,16 +90757,16 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: - default: *649 + default: *650 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *647 + '410': *648 '422': *15 '404': *6 x-github: @@ -90742,9 +90794,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: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -90756,12 +90808,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *657 headers: Link: *43 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90789,9 +90841,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: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -90815,15 +90867,15 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *468 + '301': *469 '403': *29 - '410': *647 + '410': *648 '422': *15 '404': *6 x-github: @@ -90854,9 +90906,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: - - *456 - *457 - - *654 + - *458 + - *655 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90870,13 +90922,13 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *654 + '301': *469 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *647 + '410': *648 x-github: triggersNotification: true githubCloudOnly: false @@ -90902,9 +90954,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: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -90916,12 +90968,12 @@ paths: type: array items: *227 examples: - default: *656 + default: *657 headers: Link: *43 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90938,9 +90990,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -90954,7 +91006,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &659 + - &660 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91008,7 +91060,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &661 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91144,7 +91196,7 @@ paths: - performed_via_github_app - assignee - assigner - - &661 + - &662 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91195,7 +91247,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &663 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91246,7 +91298,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &664 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91300,7 +91352,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &665 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91347,7 +91399,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &666 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91394,7 +91446,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &667 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91454,7 +91506,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &668 title: Locked Issue Event description: Locked Issue Event type: object @@ -91502,7 +91554,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &669 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91568,7 +91620,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &670 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91634,7 +91686,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &671 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91700,7 +91752,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &672 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91791,7 +91843,7 @@ paths: color: red headers: Link: *43 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91808,9 +91860,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -91820,7 +91872,7 @@ paths: application/json: schema: type: array - items: &657 + items: &658 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91867,7 +91919,7 @@ paths: - color - default examples: - default: &658 + default: &659 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91885,9 +91937,9 @@ paths: default: false headers: Link: *43 - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91904,9 +91956,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -91965,12 +92017,12 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 - '301': *468 + default: *659 + '301': *469 '404': *6 - '410': *647 + '410': *648 '422': *15 x-github: githubCloudOnly: false @@ -91987,9 +92039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -92049,12 +92101,12 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 - '301': *468 + default: *659 + '301': *469 '404': *6 - '410': *647 + '410': *648 '422': *15 x-github: githubCloudOnly: false @@ -92071,15 +92123,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 responses: '204': description: Response - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92098,9 +92150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - name: name in: path required: true @@ -92113,7 +92165,7 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: default: value: @@ -92124,9 +92176,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *468 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92146,9 +92198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: false content: @@ -92176,7 +92228,7 @@ paths: '204': description: Response '403': *29 - '410': *647 + '410': *648 '404': *6 '422': *15 x-github: @@ -92194,9 +92246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 responses: '204': description: Response @@ -92226,9 +92278,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 responses: '200': description: Response @@ -92236,10 +92288,10 @@ paths: application/json: schema: *227 examples: - default: *653 - '301': *468 + default: *654 + '301': *469 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92256,9 +92308,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - 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. @@ -92284,13 +92336,13 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92308,9 +92360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92342,16 +92394,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -92373,10 +92425,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *456 - *457 - - *654 - - *448 + - *458 + - *655 + - *449 responses: '204': description: Response @@ -92405,9 +92457,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92431,7 +92483,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92464,9 +92516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -92478,11 +92530,11 @@ paths: type: array items: *227 examples: - default: *656 + default: *657 headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92510,9 +92562,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92541,14 +92593,14 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *647 + '410': *648 '422': *15 '404': *6 x-github: @@ -92568,9 +92620,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 requestBody: required: true content: @@ -92603,7 +92655,7 @@ paths: application/json: schema: *227 examples: - default: *653 + default: *654 '403': *29 '404': *6 '422': *7 @@ -92625,9 +92677,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *456 - *457 - - *654 + - *458 + - *655 - *17 - *19 responses: @@ -92642,7 +92694,6 @@ paths: description: Timeline Event type: object anyOf: - - *659 - *660 - *661 - *662 @@ -92655,6 +92706,7 @@ paths: - *669 - *670 - *671 + - *672 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92963,7 +93015,7 @@ paths: type: string comments: type: array - items: &693 + items: &694 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93172,7 +93224,7 @@ paths: type: string comments: type: array - items: *572 + items: *573 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93461,7 +93513,7 @@ paths: headers: Link: *43 '404': *6 - '410': *647 + '410': *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93478,8 +93530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -93489,7 +93541,7 @@ paths: application/json: schema: type: array - items: &672 + items: &673 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93555,8 +93607,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -93592,9 +93644,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: &673 + default: &674 value: id: 1 key: ssh-rsa AAA... @@ -93628,9 +93680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *456 - *457 - - &674 + - *458 + - &675 name: key_id description: The unique identifier of the key. in: path @@ -93642,9 +93694,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *673 examples: - default: *673 + default: *674 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +93714,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *456 - *457 - - *674 + - *458 + - *675 responses: '204': description: Response @@ -93684,8 +93736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -93695,9 +93747,9 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 + default: *659 headers: Link: *43 '404': *6 @@ -93718,8 +93770,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -93755,9 +93807,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: - default: &675 + default: &676 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93789,8 +93841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *456 - *457 + - *458 - name: name in: path required: true @@ -93801,9 +93853,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: - default: *675 + default: *676 '404': *6 x-github: githubCloudOnly: false @@ -93820,8 +93872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *456 - *457 + - *458 - name: name in: path required: true @@ -93860,7 +93912,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *658 examples: default: value: @@ -93886,8 +93938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *456 - *457 + - *458 - name: name in: path required: true @@ -93913,8 +93965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -93950,8 +94002,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *456 - *457 + - *458 responses: '202': *39 '403': @@ -93979,8 +94031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -94006,9 +94058,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *456 - *457 - - *548 + - *458 + - *549 responses: '200': description: Response @@ -94153,8 +94205,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94219,8 +94271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94254,9 +94306,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *573 + schema: *574 examples: - default: *676 + default: *677 '204': description: Response when already merged '404': @@ -94281,8 +94333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *456 - *457 + - *458 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94323,7 +94375,7 @@ paths: application/json: schema: type: array - items: &677 + items: &678 title: Milestone description: A collection of related issues and pull requests. type: object @@ -94384,8 +94436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94425,9 +94477,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: - default: &678 + default: &679 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94486,9 +94538,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *456 - *457 - - &679 + - *458 + - &680 name: milestone_number description: The number that identifies the milestone. in: path @@ -94500,9 +94552,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: - default: *678 + default: *679 '404': *6 x-github: githubCloudOnly: false @@ -94519,9 +94571,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *456 - *457 - - *679 + - *458 + - *680 requestBody: required: false content: @@ -94559,9 +94611,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *678 examples: - default: *678 + default: *679 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94577,9 +94629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *456 - *457 - - *679 + - *458 + - *680 responses: '204': description: Response @@ -94600,9 +94652,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: - - *456 - *457 - - *679 + - *458 + - *680 - *17 - *19 responses: @@ -94612,9 +94664,9 @@ paths: application/json: schema: type: array - items: *657 + items: *658 examples: - default: *658 + default: *659 headers: Link: *43 x-github: @@ -94633,12 +94685,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: - - *456 - *457 - - *680 + - *458 - *681 - - *217 - *682 + - *217 + - *683 - *17 - *19 responses: @@ -94650,7 +94702,7 @@ paths: type: array items: *240 examples: - default: *683 + default: *684 headers: Link: *43 x-github: @@ -94674,8 +94726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -94733,14 +94785,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: &684 + schema: &685 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94865,7 +94917,7 @@ paths: - custom_404 - public examples: - default: &685 + default: &686 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94906,8 +94958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -94961,9 +95013,9 @@ paths: description: Response content: application/json: - schema: *684 + schema: *685 examples: - default: *685 + default: *686 '422': *15 '409': *114 x-github: @@ -94986,8 +95038,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -95094,8 +95146,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -95121,8 +95173,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -95132,7 +95184,7 @@ paths: application/json: schema: type: array - items: &686 + items: &687 title: Page Build description: Page Build type: object @@ -95226,8 +95278,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *456 - *457 + - *458 responses: '201': description: Response @@ -95272,16 +95324,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *686 + schema: *687 examples: - default: &687 + default: &688 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95329,8 +95381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *456 - *457 + - *458 - name: build_id in: path required: true @@ -95341,9 +95393,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *687 examples: - default: *687 + default: *688 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95363,8 +95415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -95469,9 +95521,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: - - *456 - *457 - - &688 + - *458 + - &689 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95529,9 +95581,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *456 - *457 - - *688 + - *458 + - *689 responses: '204': *150 '404': *6 @@ -95558,8 +95610,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -95817,8 +95869,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: - - *456 - *457 + - *458 responses: '200': description: Private vulnerability reporting status @@ -95855,8 +95907,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: - - *456 - *457 + - *458 responses: '204': *150 '422': *14 @@ -95877,8 +95929,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: - - *456 - *457 + - *458 responses: '204': *150 '422': *14 @@ -95900,8 +95952,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -95911,7 +95963,7 @@ paths: type: array items: *151 examples: - default: *689 + default: *690 '403': *29 '404': *6 x-github: @@ -95933,8 +95985,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -95950,7 +96002,7 @@ paths: required: - properties examples: - default: *690 + default: *691 responses: '204': description: No Content when custom property values are successfully created @@ -95988,8 +96040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *456 - *457 + - *458 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96049,9 +96101,9 @@ paths: application/json: schema: type: array - items: *577 + items: *578 examples: - default: *691 + default: *692 headers: Link: *43 '304': *37 @@ -96083,8 +96135,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -96149,7 +96201,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &696 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96306,7 +96358,7 @@ paths: nullable: true requested_teams: type: array - items: *429 + items: *430 nullable: true head: type: object @@ -96363,7 +96415,7 @@ paths: - review_comment - self author_association: *214 - auto_merge: *692 + auto_merge: *693 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96455,7 +96507,7 @@ paths: - merged_by - review_comments examples: - default: &696 + default: &697 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96982,8 +97034,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *456 - *457 + - *458 - name: sort in: query required: false @@ -97012,9 +97064,9 @@ paths: application/json: schema: type: array - items: *693 + items: *694 examples: - default: &698 + default: &699 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97091,17 +97143,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: - - *456 - *457 + - *458 - *226 responses: '200': description: Response content: application/json: - schema: *693 + schema: *694 examples: - default: &694 + default: &695 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97176,8 +97228,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: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -97200,9 +97252,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: - default: *694 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97218,8 +97270,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: - - *456 - *457 + - *458 - *226 responses: '204': @@ -97241,8 +97293,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: - - *456 - *457 + - *458 - *226 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -97269,9 +97321,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -97292,8 +97344,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: - - *456 - *457 + - *458 - *226 requestBody: required: true @@ -97326,16 +97378,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -97357,10 +97409,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *456 - *457 + - *458 - *226 - - *448 + - *449 responses: '204': description: Response @@ -97403,9 +97455,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *456 - *457 - - &697 + - *458 + - &698 name: pull_number description: The number that identifies the pull request. in: path @@ -97418,9 +97470,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *695 + schema: *696 examples: - default: *696 + default: *697 '304': *37 '404': *6 '406': @@ -97455,9 +97507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -97499,9 +97551,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *696 examples: - default: *696 + default: *697 '422': *15 '403': *29 x-github: @@ -97523,9 +97575,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: true content: @@ -97587,7 +97639,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97595,7 +97647,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '401': *25 '403': *29 '404': *6 @@ -97625,9 +97677,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: - - *456 - *457 - - *697 + - *458 + - *698 - *237 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -97648,9 +97700,9 @@ paths: application/json: schema: type: array - items: *693 + items: *694 examples: - default: *698 + default: *699 headers: Link: *43 x-github: @@ -97683,9 +97735,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: true content: @@ -97790,7 +97842,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: example-for-a-multi-line-comment: value: @@ -97878,9 +97930,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: - - *456 - *457 - - *697 + - *458 + - *698 - *226 requestBody: required: true @@ -97903,7 +97955,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *694 examples: default: value: @@ -97989,9 +98041,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 - *17 - *19 responses: @@ -98001,9 +98053,9 @@ paths: application/json: schema: type: array - items: *573 + items: *574 examples: - default: *699 + default: *700 headers: Link: *43 x-github: @@ -98033,9 +98085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *456 - *457 - - *697 + - *458 + - *698 - *17 - *19 responses: @@ -98045,7 +98097,7 @@ paths: application/json: schema: type: array - items: *586 + items: *587 examples: default: value: @@ -98083,9 +98135,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: - - *456 - *457 - - *697 + - *458 + - *698 responses: '204': description: Response if pull request has been merged @@ -98108,9 +98160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -98221,9 +98273,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: - - *456 - *457 - - *697 + - *458 + - *698 responses: '200': description: Response @@ -98298,9 +98350,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -98337,7 +98389,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: default: value: @@ -98873,9 +98925,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: true content: @@ -98909,7 +98961,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *578 examples: default: value: @@ -99414,9 +99466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *456 - *457 - - *697 + - *458 + - *698 - *17 - *19 responses: @@ -99426,7 +99478,7 @@ paths: application/json: schema: type: array - items: &700 + items: &701 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99577,9 +99629,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: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -99665,9 +99717,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &702 + default: &703 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99730,10 +99782,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: - - *456 - *457 - - *697 - - &701 + - *458 + - *698 + - &702 name: review_id description: The unique identifier of the review. in: path @@ -99745,9 +99797,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: &703 + default: &704 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99806,10 +99858,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 requestBody: required: true content: @@ -99832,7 +99884,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: default: value: @@ -99894,18 +99946,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 responses: '200': description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *702 + default: *703 '422': *7 '404': *6 x-github: @@ -99932,10 +99984,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 - *17 - *19 responses: @@ -100170,10 +100222,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 requestBody: required: true content: @@ -100201,7 +100253,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: default: value: @@ -100264,10 +100316,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: - - *456 - *457 - - *697 - - *701 + - *458 + - *698 + - *702 requestBody: required: true content: @@ -100302,9 +100354,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *701 examples: - default: *703 + default: *704 '404': *6 '422': *7 '403': *29 @@ -100326,9 +100378,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *456 - *457 - - *697 + - *458 + - *698 requestBody: required: false content: @@ -100391,8 +100443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *456 - *457 + - *458 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100405,9 +100457,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *705 examples: - default: &705 + default: &706 value: type: file encoding: base64 @@ -100449,8 +100501,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: - - *456 - *457 + - *458 - name: dir description: The alternate path to look for a README file in: path @@ -100470,9 +100522,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *705 examples: - default: *705 + default: *706 '404': *6 '422': *15 x-github: @@ -100494,8 +100546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -100505,7 +100557,7 @@ paths: application/json: schema: type: array - items: &706 + items: &707 title: Release description: A release. type: object @@ -100576,7 +100628,7 @@ paths: author: *4 assets: type: array - items: &707 + items: &708 title: Release Asset description: Data related to a release. type: object @@ -100763,8 +100815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -100840,9 +100892,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: &710 + default: &711 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100947,9 +100999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *456 - *457 - - &708 + - *458 + - &709 name: asset_id description: The unique identifier of the asset. in: path @@ -100961,9 +101013,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: &709 + default: &710 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 @@ -100998,7 +101050,7 @@ paths: type: User site_admin: false '404': *6 - '302': *588 + '302': *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101014,9 +101066,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *456 - *457 - - *708 + - *458 + - *709 requestBody: required: false content: @@ -101044,9 +101096,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *708 examples: - default: *709 + default: *710 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101062,9 +101114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *456 - *457 - - *708 + - *458 + - *709 responses: '204': description: Response @@ -101088,8 +101140,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -101174,16 +101226,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *456 - *457 + - *458 responses: '200': description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *710 + default: *711 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101200,8 +101252,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *456 - *457 + - *458 - name: tag description: tag parameter in: path @@ -101214,9 +101266,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *710 + default: *711 '404': *6 x-github: githubCloudOnly: false @@ -101238,9 +101290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *456 - *457 - - &711 + - *458 + - &712 name: release_id description: The unique identifier of the release. in: path @@ -101254,9 +101306,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: *706 + schema: *707 examples: - default: *710 + default: *711 '401': description: Unauthorized x-github: @@ -101274,9 +101326,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 requestBody: required: false content: @@ -101340,9 +101392,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *707 examples: - default: *710 + default: *711 '404': description: Not Found if the discussion category name is invalid content: @@ -101363,9 +101415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 responses: '204': description: Response @@ -101385,9 +101437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *456 - *457 - - *711 + - *458 + - *712 - *17 - *19 responses: @@ -101397,7 +101449,7 @@ paths: application/json: schema: type: array - items: *707 + items: *708 examples: default: value: @@ -101479,9 +101531,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: - - *456 - *457 - - *711 + - *458 + - *712 - name: name in: query required: true @@ -101507,7 +101559,7 @@ paths: description: Response for successful upload content: application/json: - schema: *707 + schema: *708 examples: response-for-successful-upload: value: @@ -101562,9 +101614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 - 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. @@ -101588,9 +101640,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 '404': *6 @@ -101611,9 +101663,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *456 - *457 - - *711 + - *458 + - *712 requestBody: required: true content: @@ -101643,16 +101695,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '201': description: Reaction created content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 '422': *15 x-github: githubCloudOnly: false @@ -101674,10 +101726,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *456 - *457 - - *711 - - *448 + - *458 + - *712 + - *449 responses: '204': description: Response @@ -101701,9 +101753,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *456 - *457 - - *513 + - *458 + - *514 - *17 - *19 responses: @@ -101720,7 +101772,7 @@ paths: oneOf: - allOf: - *165 - - &712 + - &713 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101741,67 +101793,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *166 - - *712 + - *713 - allOf: - *167 - - *712 + - *713 - allOf: - *168 - - *712 + - *713 - allOf: + - *714 - *713 - - *712 - allOf: - *169 - - *712 + - *713 - allOf: - *170 - - *712 + - *713 - allOf: - *171 - - *712 + - *713 - allOf: - *172 - - *712 + - *713 - allOf: - *173 - - *712 + - *713 - allOf: - *174 - - *712 + - *713 - allOf: - *175 - - *712 + - *713 - allOf: - *176 - - *712 + - *713 - allOf: - *177 - - *712 + - *713 - allOf: - *178 - - *712 + - *713 - allOf: - *179 - - *712 + - *713 - allOf: - *180 - - *712 + - *713 - allOf: - *181 - - *712 + - *713 - allOf: - *182 - - *712 + - *713 - allOf: - *183 - - *712 + - *713 - allOf: - *184 - - *712 + - *713 - allOf: - - *714 - - *712 + - *715 + - *713 examples: default: value: @@ -101840,8 +101892,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - *17 - *19 - name: includes_parents @@ -101852,7 +101904,7 @@ paths: schema: type: boolean default: true - - *715 + - *716 responses: '200': description: Response @@ -101907,8 +101959,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 requestBody: description: Request body required: true @@ -101937,7 +101989,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *716 + items: *717 required: - name - enforcement @@ -101970,7 +102022,7 @@ paths: application/json: schema: *185 examples: - default: &725 + default: &726 value: id: 42 name: super cool ruleset @@ -102017,12 +102069,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *456 - *457 - - *717 - - *101 + - *458 - *718 + - *101 - *719 + - *720 - *17 - *19 responses: @@ -102030,9 +102082,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *721 examples: - default: *721 + default: *722 '404': *6 '500': *40 x-github: @@ -102053,17 +102105,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *456 - *457 - - *722 + - *458 + - *723 responses: '200': description: Response content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 '404': *6 '500': *40 x-github: @@ -102091,8 +102143,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102114,7 +102166,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *726 '404': *6 '500': *40 put: @@ -102132,8 +102184,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102167,7 +102219,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *716 + items: *717 examples: default: value: @@ -102197,7 +102249,7 @@ paths: application/json: schema: *185 examples: - default: *725 + default: *726 '404': *6 '500': *40 delete: @@ -102215,8 +102267,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102239,8 +102291,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *456 - *457 + - *458 - *17 - *19 - name: ruleset_id @@ -102277,8 +102329,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *456 - *457 + - *458 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102351,21 +102403,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: - - *456 - *457 + - *458 - *416 - *417 - *418 - *419 + - *420 - *106 - *19 - *17 - - *726 - *727 - - *420 + - *728 - *421 - *422 - *423 + - *424 responses: '200': description: Response @@ -102373,7 +102426,7 @@ paths: application/json: schema: type: array - items: &731 + items: &732 type: object properties: number: *123 @@ -102392,8 +102445,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolved_at: type: string format: date-time @@ -102489,7 +102542,7 @@ paths: pull request. ' - oneOf: *730 + oneOf: *731 nullable: true has_more_locations: type: boolean @@ -102638,16 +102691,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: - - *456 - *457 - - *542 - - *423 + - *458 + - *543 + - *424 responses: '200': description: Response content: application/json: - schema: *731 + schema: *732 examples: default: value: @@ -102689,6 +102742,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. @@ -102699,9 +102754,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: - - *456 - *457 - - *542 + - *458 + - *543 requestBody: required: true content: @@ -102709,27 +102764,42 @@ paths: schema: type: object properties: - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *731 + schema: *732 examples: default: value: @@ -102774,6 +102844,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. @@ -102781,7 +102870,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': *190 x-github: enabledForGitHubApps: true @@ -102804,9 +102894,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: - - *456 - *457 - - *542 + - *458 + - *543 - *19 - *17 responses: @@ -102817,7 +102907,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &912 + items: &913 type: object properties: type: @@ -102843,7 +102933,6 @@ paths: example: commit details: oneOf: - - *732 - *733 - *734 - *735 @@ -102856,6 +102945,7 @@ paths: - *742 - *743 - *744 + - *745 examples: default: value: @@ -102941,8 +103031,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -102950,14 +103040,14 @@ paths: schema: type: object properties: - reason: &746 + reason: &747 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *745 + placeholder_id: *746 required: - reason - placeholder_id @@ -102974,7 +103064,7 @@ paths: schema: type: object properties: - reason: *746 + reason: *747 expire_at: type: string format: date-time @@ -103020,8 +103110,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: - - *456 - *457 + - *458 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -103036,7 +103126,7 @@ paths: properties: incremental_scans: type: array - items: &747 + items: &748 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103062,15 +103152,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *747 + items: *748 backfill_scans: type: array - items: *747 + items: *748 custom_pattern_backfill_scans: type: array items: allOf: - - *747 + - *748 - type: object properties: pattern_name: @@ -103140,8 +103230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *456 - *457 + - *458 - *106 - name: sort description: The property to sort the results by. @@ -103185,9 +103275,9 @@ paths: application/json: schema: type: array - items: *748 + items: *749 examples: - default: *749 + default: *750 '400': *14 '404': *6 x-github: @@ -103210,8 +103300,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -103284,7 +103374,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -103371,9 +103461,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: &751 + default: &752 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103606,8 +103696,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -103711,7 +103801,7 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: default: value: @@ -103858,17 +103948,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: - - *456 - *457 - - *750 + - *458 + - *751 responses: '200': description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 + default: *752 '403': *29 '404': *6 x-github: @@ -103892,9 +103982,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: - - *456 - *457 - - *750 + - *458 + - *751 requestBody: required: true content: @@ -103967,7 +104057,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *429 required: - login - type @@ -104053,10 +104143,10 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 - add_credit: *751 + default: *752 + add_credit: *752 '403': *29 '404': *6 '422': @@ -104094,9 +104184,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: - - *456 - *457 - - *750 + - *458 + - *751 responses: '202': *39 '400': *14 @@ -104123,17 +104213,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: - - *456 - *457 - - *750 + - *458 + - *751 responses: '202': description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 '400': *14 '422': *15 '403': *29 @@ -104159,8 +104249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -104259,8 +104349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *456 - *457 + - *458 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104269,7 +104359,7 @@ paths: application/json: schema: type: array - items: &752 + items: &753 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104302,8 +104392,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -104379,8 +104469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -104476,8 +104566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *456 - *457 + - *458 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104631,8 +104721,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: - - *456 - *457 + - *458 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104642,7 +104732,7 @@ paths: application/json: schema: type: array - items: *752 + items: *753 examples: default: value: @@ -104675,8 +104765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *456 - *457 + - *458 - name: sha in: path required: true @@ -104730,7 +104820,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -104784,8 +104874,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -104817,14 +104907,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *456 - *457 + - *458 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &754 + schema: &755 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104892,8 +104982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *456 - *457 + - *458 requestBody: required: false content: @@ -104919,7 +105009,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *755 examples: default: value: @@ -104946,8 +105036,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -104967,8 +105057,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -105047,8 +105137,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: - - *456 - *457 + - *458 responses: '200': description: Response @@ -105056,7 +105146,7 @@ paths: application/json: schema: type: array - items: &755 + items: &756 title: Tag protection description: Tag protection type: object @@ -105108,8 +105198,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: - - *456 - *457 + - *458 requestBody: required: true content: @@ -105132,7 +105222,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *756 examples: default: value: @@ -105163,8 +105253,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: - - *456 - *457 + - *458 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105201,8 +105291,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *456 - *457 + - *458 - name: ref in: path required: true @@ -105238,8 +105328,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *456 - *457 + - *458 - *17 - *19 responses: @@ -105271,8 +105361,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *456 - *457 + - *458 - *19 - *17 responses: @@ -105280,7 +105370,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &757 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105292,7 +105382,7 @@ paths: required: - names examples: - default: &757 + default: &758 value: names: - octocat @@ -105315,8 +105405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -105347,9 +105437,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *757 examples: - default: *757 + default: *758 '404': *6 '422': *7 x-github: @@ -105370,9 +105460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *456 - *457 - - &758 + - *458 + - &759 name: per description: The time frame to display results for. in: query @@ -105401,7 +105491,7 @@ paths: example: 128 clones: type: array - items: &759 + items: &760 title: Traffic type: object properties: @@ -105488,8 +105578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -105579,8 +105669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *456 - *457 + - *458 responses: '200': description: Response @@ -105640,9 +105730,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *456 - *457 - - *758 + - *458 + - *759 responses: '200': description: Response @@ -105661,7 +105751,7 @@ paths: example: 3782 views: type: array - items: *759 + items: *760 required: - uniques - count @@ -105738,8 +105828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *456 - *457 + - *458 requestBody: required: true content: @@ -106013,8 +106103,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: - - *456 - *457 + - *458 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106037,8 +106127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -106060,8 +106150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *456 - *457 + - *458 responses: '204': description: Response @@ -106087,8 +106177,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *456 - *457 + - *458 - name: ref in: path required: true @@ -106180,9 +106270,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106333,7 +106423,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &768 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106342,7 +106432,7 @@ paths: schema: type: string example: members - - &772 + - &773 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106353,7 +106443,7 @@ paths: default: 1 format: int32 example: 1 - - &773 + - &774 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106395,7 +106485,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &763 allOf: - type: object required: @@ -106470,7 +106560,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: &774 + meta: &775 type: object description: The metadata associated with the creation/updates to the user. @@ -106530,30 +106620,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &764 description: Bad request content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *761 + '401': *762 + '403': &765 description: Permission denied - '429': &765 + '429': &766 description: Too many requests content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '500': &766 + schema: *761 + '500': &767 description: Internal server error content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 + schema: *761 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106577,7 +106667,7 @@ paths: required: true content: application/json: - schema: &770 + schema: &771 type: object required: - schemas @@ -106637,9 +106727,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *763 examples: - group: &768 + group: &769 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106658,13 +106748,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': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *764 + '401': *762 + '403': *765 + '409': &772 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106681,7 +106771,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: - - &769 + - &770 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106689,22 +106779,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *768 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *763 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106723,13 +106813,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: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: *770 + schema: *771 examples: group: summary: Group @@ -106755,17 +106845,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *769 + groupWithMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106789,13 +106879,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: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: &781 + schema: &782 type: object required: - Operations @@ -106855,17 +106945,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *769 + addMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106881,17 +106971,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: - - *769 + - *770 - *41 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106925,8 +107015,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - *773 + - *774 - *41 responses: '200': @@ -106959,7 +107049,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &777 allOf: - type: object required: @@ -107038,7 +107128,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &775 + roles: &776 type: array description: The roles assigned to the user. items: @@ -107094,7 +107184,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *775 startIndex: type: integer description: A starting index for the returned page @@ -107131,11 +107221,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *764 + '401': *762 + '403': *765 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107159,7 +107249,7 @@ paths: required: true content: application/json: - schema: &779 + schema: &780 type: object required: - schemas @@ -107241,9 +107331,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *775 + roles: *776 examples: - user: &780 + user: &781 summary: User value: schemas: @@ -107290,9 +107380,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *777 examples: - user: &777 + user: &778 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107318,13 +107408,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: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *778 + '400': *764 + '401': *762 + '403': *765 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107341,7 +107431,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: - - &778 + - &779 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107354,15 +107444,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *777 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107384,30 +107474,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: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *779 + schema: *780 examples: - user: *780 + user: *781 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107442,13 +107532,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: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *782 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107488,18 +107578,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *778 + userSingleValuedProperties: *778 + disableUser: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107519,17 +107609,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: - - *778 + - *779 - *41 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107616,7 +107706,7 @@ paths: example: 1 Resources: type: array - items: &782 + items: &783 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107847,22 +107937,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': *37 - '404': &783 + '404': &784 description: Resource not found content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '403': &784 + schema: *761 + '403': &785 description: Forbidden content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *761 + '400': *764 + '429': *766 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107888,9 +107978,9 @@ paths: description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: &785 + default: &786 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107913,17 +108003,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': *37 - '404': *783 - '403': *784 - '500': *766 + '404': *784 + '403': *785 + '500': *767 '409': description: Conflict content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 + schema: *761 + '400': *764 requestBody: required: true content: @@ -108021,17 +108111,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *83 - - *778 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 - '404': *783 - '403': *784 + default: *786 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108055,18 +108145,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *83 - - *778 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 + '404': *784 + '403': *785 requestBody: required: true content: @@ -108179,19 +108269,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *83 - - *778 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 - '400': *763 + '404': *784 + '403': *785 + '400': *764 '429': description: Response content: @@ -108282,12 +108372,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *83 - - *778 + - *779 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108420,7 +108510,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &786 + text_matches: &787 title: Search Result Text Matches type: array items: @@ -108583,7 +108673,7 @@ paths: enum: - author-date - committer-date - - &787 + - &788 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 @@ -108654,7 +108744,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *512 nullable: true comment_count: type: integer @@ -108674,7 +108764,7 @@ paths: url: type: string format: uri - verification: *633 + verification: *634 required: - author - committer @@ -108693,7 +108783,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *512 nullable: true parents: type: array @@ -108711,7 +108801,7 @@ paths: type: number node_id: type: string - text_matches: *786 + text_matches: *787 required: - sha - node_id @@ -108904,7 +108994,7 @@ paths: - interactions - created - updated - - *787 + - *788 - *17 - *19 - name: advanced_search @@ -109001,11 +109091,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: type: string state_reason: @@ -109037,7 +109127,7 @@ paths: type: string format: date-time nullable: true - text_matches: *786 + text_matches: *787 pull_request: type: object properties: @@ -109262,7 +109352,7 @@ paths: enum: - created - updated - - *787 + - *788 - *17 - *19 responses: @@ -109306,7 +109396,7 @@ paths: nullable: true score: type: number - text_matches: *786 + text_matches: *787 required: - id - node_id @@ -109392,7 +109482,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *788 - *17 - *19 responses: @@ -109631,7 +109721,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *787 temp_clone_token: type: string allow_merge_commit: @@ -109932,7 +110022,7 @@ paths: type: string format: uri nullable: true - text_matches: *786 + text_matches: *787 related: type: array nullable: true @@ -110125,7 +110215,7 @@ paths: - followers - repositories - joined - - *787 + - *788 - *17 - *19 responses: @@ -110229,7 +110319,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *786 + text_matches: *787 blog: type: string nullable: true @@ -110308,7 +110398,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &791 + - &792 name: team_id description: The unique identifier of the team. in: path @@ -110320,9 +110410,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 x-github: githubCloudOnly: false @@ -110349,7 +110439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110412,16 +110502,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '201': description: Response content: application/json: - schema: *437 + schema: *438 examples: - default: *438 + default: *439 '404': *6 '422': *15 '403': *29 @@ -110449,7 +110539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *791 + - *792 responses: '204': description: Response @@ -110480,7 +110570,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *791 + - *792 - *106 - *17 - *19 @@ -110491,9 +110581,9 @@ paths: application/json: schema: type: array - items: *439 + items: *440 examples: - default: *792 + default: *793 headers: Link: *43 x-github: @@ -110522,7 +110612,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110556,9 +110646,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: triggersNotification: true githubCloudOnly: false @@ -110585,16 +110675,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *442 responses: '200': description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *440 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110619,8 +110709,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *442 requestBody: required: false content: @@ -110643,9 +110733,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *440 examples: - default: *793 + default: *794 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110670,8 +110760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *442 responses: '204': description: Response @@ -110700,8 +110790,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *791 - - *441 + - *792 + - *442 - *106 - *17 - *19 @@ -110712,9 +110802,9 @@ paths: application/json: schema: type: array - items: *442 + items: *443 examples: - default: *794 + default: *795 headers: Link: *43 x-github: @@ -110743,8 +110833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *791 - - *441 + - *792 + - *442 requestBody: required: true content: @@ -110766,9 +110856,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: triggersNotification: true githubCloudOnly: false @@ -110795,17 +110885,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 responses: '200': description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *443 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110830,9 +110920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 requestBody: required: true content: @@ -110854,9 +110944,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *443 examples: - default: *795 + default: *796 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110881,9 +110971,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 responses: '204': description: Response @@ -110912,9 +111002,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: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 - 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. @@ -110940,9 +111030,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -110971,9 +111061,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: - - *791 - - *441 - - *444 + - *792 + - *442 + - *445 requestBody: required: true content: @@ -111005,9 +111095,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111033,8 +111123,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: - - *791 - - *441 + - *792 + - *442 - 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. @@ -111060,9 +111150,9 @@ paths: application/json: schema: type: array - items: *445 + items: *446 examples: - default: *447 + default: *448 headers: Link: *43 x-github: @@ -111091,8 +111181,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: - - *791 - - *441 + - *792 + - *442 requestBody: required: true content: @@ -111124,9 +111214,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *446 examples: - default: *446 + default: *447 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111150,7 +111240,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111188,7 +111278,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *791 + - *792 - name: role description: Filters members returned by their role in the team. in: query @@ -111239,7 +111329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *791 + - *792 - *138 responses: '204': @@ -111276,7 +111366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *791 + - *792 - *138 responses: '204': @@ -111316,7 +111406,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *791 + - *792 - *138 responses: '204': @@ -111353,16 +111443,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: - - *791 + - *792 - *138 responses: '200': description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-user-is-a-team-maintainer: *796 + response-if-user-is-a-team-maintainer: *797 '404': *6 x-github: githubCloudOnly: false @@ -111395,7 +111485,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: - - *791 + - *792 - *138 requestBody: required: false @@ -111421,9 +111511,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *454 examples: - response-if-users-membership-with-team-is-now-pending: *797 + response-if-users-membership-with-team-is-now-pending: *798 '403': description: Forbidden if team synchronization is set up '422': @@ -111457,7 +111547,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: - - *791 + - *792 - *138 responses: '204': @@ -111486,7 +111576,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111496,9 +111586,9 @@ paths: application/json: schema: type: array - items: *454 + items: *455 examples: - default: *798 + default: *799 headers: Link: *43 '404': *6 @@ -111524,16 +111614,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: - - *791 - - *455 + - *792 + - *456 responses: '200': description: Response content: application/json: - schema: *454 + schema: *455 examples: - default: *799 + default: *800 '404': description: Not Found if project is not managed by this team x-github: @@ -111557,8 +111647,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: - - *791 - - *455 + - *792 + - *456 requestBody: required: false content: @@ -111625,8 +111715,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: - - *791 - - *455 + - *792 + - *456 responses: '204': description: Response @@ -111653,7 +111743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111695,15 +111785,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: - - *791 - - *456 + - *792 - *457 + - *458 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *800 + schema: *801 examples: alternative-response-with-extra-repository-information: value: @@ -111854,9 +111944,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: - - *791 - - *456 + - *792 - *457 + - *458 requestBody: required: false content: @@ -111906,9 +111996,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: - - *791 - - *456 + - *792 - *457 + - *458 responses: '204': description: Response @@ -111937,15 +112027,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: - - *791 + - *792 responses: '200': description: Response content: application/json: - schema: *458 + schema: *459 examples: - default: *459 + default: *460 '403': *29 '404': *6 x-github: @@ -111972,7 +112062,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: - - *791 + - *792 requestBody: required: true content: @@ -112029,7 +112119,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *459 examples: default: value: @@ -112060,7 +112150,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -112072,7 +112162,7 @@ paths: type: array items: *303 examples: - response-if-child-teams-exist: *801 + response-if-child-teams-exist: *802 headers: Link: *43 '404': *6 @@ -112105,7 +112195,7 @@ paths: application/json: schema: oneOf: - - &803 + - &804 title: Private User description: Private User type: object @@ -112308,7 +112398,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *802 + - *803 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112461,7 +112551,7 @@ paths: description: Response content: application/json: - schema: *803 + schema: *804 examples: default: value: @@ -112807,7 +112897,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -112815,7 +112905,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '401': *25 '403': *29 '404': *6 @@ -112859,7 +112949,7 @@ paths: type: integer secrets: type: array - items: &804 + items: &805 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112899,7 +112989,7 @@ paths: - visibility - selected_repositories_url examples: - default: *565 + default: *566 headers: Link: *43 x-github: @@ -112975,7 +113065,7 @@ paths: description: Response content: application/json: - schema: *804 + schema: *805 examples: default: value: @@ -113121,7 +113211,7 @@ paths: type: array items: *274 examples: - default: *805 + default: *806 '401': *25 '403': *29 '404': *6 @@ -113273,7 +113363,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '304': *37 '500': *40 '401': *25 @@ -113331,7 +113421,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '401': *25 '403': *29 '404': *6 @@ -113388,7 +113478,7 @@ paths: description: Response content: application/json: - schema: &806 + schema: &807 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113429,7 +113519,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &807 + default: &808 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113474,9 +113564,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *807 examples: - default: *807 + default: *808 '404': *6 x-github: githubCloudOnly: false @@ -113513,9 +113603,9 @@ paths: type: integer machines: type: array - items: *808 + items: *809 examples: - default: *809 + default: *810 '304': *37 '500': *40 '401': *25 @@ -113594,13 +113684,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *467 + repository: *468 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *564 + required: *565 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114382,7 +114472,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '304': *37 '500': *40 '400': *14 @@ -114422,7 +114512,7 @@ paths: application/json: schema: *365 examples: - default: *562 + default: *563 '500': *40 '401': *25 '403': *29 @@ -114454,7 +114544,7 @@ paths: type: array items: *376 examples: - default: &820 + default: &821 value: - id: 197 name: hello_docker @@ -114555,7 +114645,7 @@ paths: application/json: schema: type: array - items: &810 + items: &811 title: Email description: Email type: object @@ -114620,9 +114710,9 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: - default: &822 + default: &823 value: - email: octocat@github.com verified: true @@ -114697,7 +114787,7 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: default: value: @@ -114953,7 +115043,7 @@ paths: application/json: schema: type: array - items: &811 + items: &812 title: GPG Key description: A unique encryption key type: object @@ -115084,7 +115174,7 @@ paths: - subkeys - revoked examples: - default: &836 + default: &837 value: - id: 3 name: Octocat's GPG Key @@ -115169,9 +115259,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *812 examples: - default: &812 + default: &813 value: id: 3 name: Octocat's GPG Key @@ -115228,7 +115318,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: - - &813 + - &814 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115240,9 +115330,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *812 examples: - default: *812 + default: *813 '404': *6 '304': *37 '403': *29 @@ -115265,7 +115355,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: - - *813 + - *814 responses: '204': description: Response @@ -115570,7 +115660,7 @@ paths: required: true content: application/json: - schema: *644 + schema: *645 examples: default: value: @@ -115720,7 +115810,7 @@ paths: application/json: schema: type: array - items: &814 + items: &815 title: Key description: Key type: object @@ -115821,9 +115911,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *815 examples: - default: &815 + default: &816 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115856,15 +115946,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: - - *674 + - *675 responses: '200': description: Response content: application/json: - schema: *814 + schema: *815 examples: - default: *815 + default: *816 '404': *6 '304': *37 '403': *29 @@ -115887,7 +115977,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: - - *674 + - *675 responses: '204': description: Response @@ -115920,7 +116010,7 @@ paths: application/json: schema: type: array - items: &816 + items: &817 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115988,7 +116078,7 @@ paths: - account - plan examples: - default: &817 + default: &818 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116050,9 +116140,9 @@ paths: application/json: schema: type: array - items: *816 + items: *817 examples: - default: *817 + default: *818 headers: Link: *43 '304': *37 @@ -117047,7 +117137,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *371 - - *818 + - *819 responses: '204': description: Response @@ -117162,7 +117252,7 @@ paths: - docker - nuget - container - - *819 + - *820 - *19 - *17 responses: @@ -117174,8 +117264,8 @@ paths: type: array items: *376 examples: - default: *820 - '400': *821 + default: *821 + '400': *822 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117204,7 +117294,7 @@ paths: application/json: schema: *376 examples: - default: &837 + default: &838 value: id: 40201 name: octo-name @@ -117566,9 +117656,9 @@ paths: application/json: schema: type: array - items: *810 + items: *811 examples: - default: *822 + default: *823 headers: Link: *43 '304': *37 @@ -117681,7 +117771,7 @@ paths: type: array items: *74 examples: - default: &829 + default: &830 summary: Default response value: - id: 1296269 @@ -117985,9 +118075,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *468 examples: - default: *469 + default: *470 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -118025,9 +118115,9 @@ paths: application/json: schema: type: array - items: *646 + items: *647 examples: - default: *823 + default: *824 headers: Link: *43 '304': *37 @@ -118106,7 +118196,7 @@ paths: application/json: schema: type: array - items: &824 + items: &825 title: Social account description: Social media account type: object @@ -118121,7 +118211,7 @@ paths: - provider - url examples: - default: &825 + default: &826 value: - provider: twitter url: https://twitter.com/github @@ -118183,9 +118273,9 @@ paths: application/json: schema: type: array - items: *824 + items: *825 examples: - default: *825 + default: *826 '422': *15 '304': *37 '404': *6 @@ -118272,7 +118362,7 @@ paths: application/json: schema: type: array - items: &826 + items: &827 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118292,7 +118382,7 @@ paths: - title - created_at examples: - default: &841 + default: &842 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118356,9 +118446,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *827 examples: - default: &827 + default: &828 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118388,7 +118478,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: - - &828 + - &829 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118400,9 +118490,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *827 examples: - default: *827 + default: *828 '404': *6 '304': *37 '403': *29 @@ -118425,7 +118515,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: - - *828 + - *829 responses: '204': description: Response @@ -118454,7 +118544,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: - - &842 + - &843 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 @@ -118479,11 +118569,11 @@ paths: type: array items: *74 examples: - default-response: *829 + default-response: *830 application/vnd.github.v3.star+json: schema: type: array - items: &843 + items: &844 title: Starred Repository description: Starred Repository type: object @@ -118639,8 +118729,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: - - *456 - *457 + - *458 responses: '204': description: Response if this repository is starred by you @@ -118668,8 +118758,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -118693,8 +118783,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: - - *456 - *457 + - *458 responses: '204': description: Response @@ -118766,7 +118856,7 @@ paths: application/json: schema: type: array - items: *437 + items: *438 examples: default: value: @@ -118852,10 +118942,10 @@ paths: application/json: schema: oneOf: + - *804 - *803 - - *802 examples: - default-response: &831 + default-response: &832 summary: Default response value: login: octocat @@ -118890,7 +118980,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &832 + response-with-git-hub-plan-information: &833 summary: Response with GitHub plan information value: login: octocat @@ -119012,7 +119102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *830 + - *831 - *17 responses: '200': @@ -119061,11 +119151,11 @@ paths: application/json: schema: oneOf: + - *804 - *803 - - *802 examples: - default-response: *831 - response-with-git-hub-plan-information: *832 + default-response: *832 + response-with-git-hub-plan-information: *833 '404': *6 x-github: githubCloudOnly: false @@ -119115,8 +119205,8 @@ paths: required: - subject_digests examples: - default: *833 - withPredicateType: *834 + default: *834 + withPredicateType: *835 responses: '200': description: Response @@ -119169,7 +119259,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *835 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119374,7 +119464,7 @@ paths: initiator: type: string examples: - default: *507 + default: *508 '201': description: Response content: @@ -119415,7 +119505,7 @@ paths: type: array items: *376 examples: - default: *820 + default: *821 '403': *29 '401': *25 x-github: @@ -119799,9 +119889,9 @@ paths: application/json: schema: type: array - items: *811 + items: *812 examples: - default: *836 + default: *837 headers: Link: *43 x-github: @@ -119905,7 +119995,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *644 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120029,7 +120119,7 @@ paths: - docker - nuget - container - - *819 + - *820 - *138 - *19 - *17 @@ -120042,10 +120132,10 @@ paths: type: array items: *376 examples: - default: *820 + default: *821 '403': *29 '401': *25 - '400': *821 + '400': *822 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120075,7 +120165,7 @@ paths: application/json: schema: *376 examples: - default: *837 + default: *838 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120424,7 +120514,7 @@ paths: type: array items: *398 examples: - default: *838 + default: *839 headers: Link: *43 '304': *37 @@ -120435,6 +120525,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: + - *138 + - *394 + 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: *398 + 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': *37 + '403': *29 + '401': *25 + '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 @@ -120447,7 +120788,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - *394 - - *839 + - *840 - *138 responses: '200': @@ -120456,7 +120797,7 @@ paths: application/json: schema: *398 examples: - default: *840 + default: *841 headers: Link: *43 '304': *37 @@ -120991,9 +121332,9 @@ paths: application/json: schema: type: array - items: *824 + items: *825 examples: - default: *825 + default: *826 headers: Link: *43 x-github: @@ -121023,9 +121364,9 @@ paths: application/json: schema: type: array - items: *826 + items: *827 examples: - default: *841 + default: *842 headers: Link: *43 x-github: @@ -121050,7 +121391,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *138 - - *842 + - *843 - *106 - *17 - *19 @@ -121062,11 +121403,11 @@ paths: schema: anyOf: - type: array - items: *843 + items: *844 - type: array items: *74 examples: - default-response: *829 + default-response: *830 headers: Link: *43 x-github: @@ -121225,7 +121566,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &844 + enterprise: &845 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121283,7 +121624,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &845 + installation: &846 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121302,7 +121643,7 @@ x-webhooks: required: - id - node_id - organization: &846 + organization: &847 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121362,13 +121703,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &847 + repository: &848 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &884 + properties: &885 id: description: Unique identifier of the repository example: 42 @@ -122051,7 +122392,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &885 + required: &886 - archive_url - assignees_url - blobs_url @@ -122202,10 +122543,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -122281,11 +122622,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: &848 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + rule: &849 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) @@ -122508,11 +122849,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + rule: *849 sender: *4 required: - action @@ -122695,11 +123036,11 @@ x-webhooks: - everyone required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + rule: *849 sender: *4 required: - action @@ -122772,7 +123113,7 @@ x-webhooks: required: true content: application/json: - schema: &868 + schema: &869 title: Exemption request cancellation event type: object properties: @@ -122780,11 +123121,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: &849 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: &850 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123017,7 +123358,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &850 + items: &851 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123127,7 +123468,7 @@ x-webhooks: required: true content: application/json: - schema: &869 + schema: &870 title: Exemption request completed event type: object properties: @@ -123135,11 +123476,11 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 sender: *4 required: - action @@ -123211,7 +123552,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &867 title: Exemption request created event type: object properties: @@ -123219,11 +123560,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 sender: *4 required: - action @@ -123295,7 +123636,7 @@ x-webhooks: required: true content: application/json: - schema: &870 + schema: &871 title: Exemption response dismissed event type: object properties: @@ -123303,12 +123644,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 + exemption_response: *851 sender: *4 required: - action @@ -123382,7 +123723,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &868 title: Exemption response submitted event type: object properties: @@ -123390,12 +123731,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + exemption_request: *850 + exemption_response: *851 sender: *4 required: - action @@ -123479,7 +123820,7 @@ x-webhooks: type: string enum: - completed - check_run: &852 + check_run: &853 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123532,7 +123873,7 @@ x-webhooks: type: string pull_requests: type: array - items: *524 + items: *525 repository: *274 status: example: completed @@ -123570,7 +123911,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *851 + deployment: *852 details_url: example: https://example.com type: string @@ -123620,7 +123961,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *524 + items: *525 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -123655,10 +123996,10 @@ x-webhooks: - output - app - pull_requests - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 sender: *4 required: - check_run @@ -124051,11 +124392,11 @@ x-webhooks: type: string enum: - created - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *853 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 sender: *4 required: - check_run @@ -124451,11 +124792,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *853 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 requested_action: description: The action requested by the user. type: object @@ -124860,11 +125201,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *853 + installation: *846 + enterprise: *845 + organization: *847 + repository: *848 sender: *4 required: - check_run @@ -125841,10 +126182,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -126117,6 +126458,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -126529,10 +126875,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -126800,6 +127146,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -127211,10 +127562,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -127380,7 +127731,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127525,20 +127876,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &853 + commit_oid: &854 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: *844 - installation: *845 - organization: *846 - ref: &854 + enterprise: *845 + installation: *846 + organization: *847 + ref: &855 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: *847 + repository: *848 sender: *4 required: - action @@ -127703,7 +128054,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127933,12 +128284,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -128033,7 +128384,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128204,12 +128555,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -128375,7 +128726,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128541,12 +128892,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -128646,7 +128997,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128814,16 +129165,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 ref: 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 nullable: true - repository: *847 + repository: *848 sender: *4 required: - action @@ -128920,7 +129271,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *538 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129060,12 +129411,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *854 + enterprise: *845 + installation: *846 + organization: *847 + ref: *855 + repository: *848 sender: *4 required: - action @@ -129322,10 +129673,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -129405,18 +129756,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *846 - pusher_type: &855 + organization: *847 + pusher_type: &856 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &856 + ref: &857 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -129426,7 +129777,7 @@ x-webhooks: enum: - tag - branch - repository: *847 + repository: *848 sender: *4 required: - ref @@ -129509,9 +129860,9 @@ x-webhooks: enum: - created definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129596,9 +129947,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129676,9 +130027,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129756,9 +130107,9 @@ x-webhooks: enum: - updated definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -129835,10 +130186,10 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - repository: *847 - organization: *846 + enterprise: *845 + installation: *846 + repository: *848 + organization: *847 sender: *4 new_property_values: type: array @@ -129923,18 +130274,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - pusher_type: *855 - ref: *856 + enterprise: *845 + installation: *846 + organization: *847 + pusher_type: *856 + ref: *857 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *847 + repository: *848 sender: *4 required: - ref @@ -130018,11 +130369,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130106,11 +130457,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130194,11 +130545,11 @@ x-webhooks: type: string enum: - created - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130280,11 +130631,11 @@ x-webhooks: type: string enum: - dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130366,11 +130717,11 @@ x-webhooks: type: string enum: - fixed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130453,11 +130804,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130539,11 +130890,11 @@ x-webhooks: type: string enum: - reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *594 + installation: *846 + organization: *847 + enterprise: *845 + repository: *848 sender: *4 required: - action @@ -130620,9 +130971,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - key: &857 + enterprise: *845 + installation: *846 + key: &858 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130658,8 +131009,8 @@ x-webhooks: - verified - created_at - read_only - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -130736,11 +131087,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - key: *857 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + key: *858 + organization: *847 + repository: *848 sender: *4 required: - action @@ -131301,12 +131652,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: &861 + workflow: &862 title: Workflow type: object nullable: true @@ -132032,13 +132383,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *599 + deployment: *600 pull_requests: type: array - items: *695 - repository: *847 - organization: *846 - installation: *845 + items: *696 + repository: *848 + organization: *847 + installation: *846 sender: *4 responses: '200': @@ -132109,7 +132460,7 @@ x-webhooks: type: string enum: - approved - approver: &858 + approver: &859 type: object properties: avatar_url: @@ -132152,11 +132503,11 @@ x-webhooks: type: string comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: &859 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + reviewers: &860 type: array items: type: object @@ -132235,7 +132586,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &860 + workflow_job_run: &861 type: object properties: conclusion: @@ -132966,18 +133317,18 @@ x-webhooks: type: string enum: - rejected - approver: *858 + approver: *859 comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: *859 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + reviewers: *860 sender: *4 since: type: string - workflow_job_run: *860 + workflow_job_run: *861 workflow_job_runs: type: array items: @@ -133681,13 +134032,13 @@ x-webhooks: type: string enum: - requested - enterprise: *844 + enterprise: *845 environment: type: string - installation: *845 - organization: *846 - repository: *847 - requestor: &871 + installation: *846 + organization: *847 + repository: *848 + requestor: &872 title: User type: object nullable: true @@ -135586,12 +135937,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Deployment Workflow Run type: object @@ -136271,7 +136622,7 @@ x-webhooks: type: string enum: - answered - answer: &864 + answer: &865 type: object properties: author_association: @@ -136428,7 +136779,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &862 + discussion: &863 title: Discussion description: A Discussion in a repository. type: object @@ -136714,7 +137065,7 @@ x-webhooks: - id labels: type: array - items: *657 + items: *658 required: - repository_url - category @@ -136736,10 +137087,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -136866,11 +137217,11 @@ x-webhooks: - from required: - category - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -136953,11 +137304,11 @@ x-webhooks: type: string enum: - closed - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137039,7 +137390,7 @@ x-webhooks: type: string enum: - created - comment: &863 + comment: &864 type: object properties: author_association: @@ -137196,11 +137547,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137283,12 +137634,12 @@ x-webhooks: type: string enum: - deleted - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *864 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137383,12 +137734,12 @@ x-webhooks: - from required: - body - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *864 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137472,11 +137823,11 @@ x-webhooks: type: string enum: - created - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137558,11 +137909,11 @@ x-webhooks: type: string enum: - deleted - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137662,11 +138013,11 @@ x-webhooks: type: string required: - from - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137748,10 +138099,10 @@ x-webhooks: type: string enum: - labeled - discussion: *862 - enterprise: *844 - installation: *845 - label: &865 + discussion: *863 + enterprise: *845 + installation: *846 + label: &866 title: Label type: object properties: @@ -137783,8 +138134,8 @@ x-webhooks: - color - default - description - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137867,11 +138218,11 @@ x-webhooks: type: string enum: - locked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -137953,11 +138304,11 @@ x-webhooks: type: string enum: - pinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138039,11 +138390,11 @@ x-webhooks: type: string enum: - reopened - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138128,16 +138479,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *862 - new_repository: *847 + new_discussion: *863 + new_repository: *848 required: - new_discussion - new_repository - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138220,10 +138571,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *862 - old_answer: *864 - organization: *846 - repository: *847 + discussion: *863 + old_answer: *865 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138305,12 +138656,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *862 - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138393,11 +138744,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138479,11 +138830,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *863 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -138552,7 +138903,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138615,7 +138966,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138681,7 +139032,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138747,7 +139098,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *870 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138813,7 +139164,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138879,7 +139230,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *871 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138945,7 +139296,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138971,71 +139322,6 @@ x-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: *868 - 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 @@ -139088,6 +139374,71 @@ x-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: *870 + 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: |- @@ -139140,7 +139491,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139205,7 +139556,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *871 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139271,7 +139622,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139338,7 +139689,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *844 + enterprise: *845 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -139998,9 +140349,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - forkee @@ -140146,9 +140497,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pages: description: The pages that were updated. type: array @@ -140185,7 +140536,7 @@ x-webhooks: - action - sha - html_url - repository: *847 + repository: *848 sender: *4 required: - pages @@ -140261,10 +140612,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: &872 + organization: *847 + repositories: &873 description: An array of repository objects that the installation can access. type: array @@ -140290,8 +140641,8 @@ x-webhooks: - name - full_name - private - repository: *847 - requester: *871 + repository: *848 + requester: *872 sender: *4 required: - action @@ -140366,11 +140717,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -140446,11 +140797,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -140526,10 +140877,10 @@ x-webhooks: type: string enum: - added - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories_added: &873 + organization: *847 + repositories_added: &874 description: An array of repository objects, which were added to the installation. type: array @@ -140575,15 +140926,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *847 - repository_selection: &874 + repository: *848 + repository_selection: &875 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *871 + requester: *872 sender: *4 required: - action @@ -140662,10 +141013,10 @@ x-webhooks: type: string enum: - removed - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories_added: *873 + organization: *847 + repositories_added: *874 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140692,9 +141043,9 @@ x-webhooks: - name - full_name - private - repository: *847 - repository_selection: *874 - requester: *871 + repository: *848 + repository_selection: *875 + requester: *872 sender: *4 required: - action @@ -140773,11 +141124,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -140956,10 +141307,10 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 target_type: type: string @@ -141038,11 +141389,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *844 + enterprise: *845 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *847 + repositories: *873 + repository: *848 requester: nullable: true sender: *4 @@ -141294,8 +141645,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142089,8 +142440,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142439,8 +142790,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -142520,7 +142871,7 @@ x-webhooks: type: string enum: - deleted - comment: &875 + comment: &876 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -142685,8 +143036,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143476,8 +143827,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143828,8 +144179,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -143909,7 +144260,7 @@ x-webhooks: type: string enum: - edited - changes: &904 + changes: &905 description: The changes to the comment. type: object properties: @@ -143921,9 +144272,9 @@ x-webhooks: type: string required: - from - comment: *875 - enterprise: *844 - installation: *845 + comment: *876 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144716,8 +145067,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145066,8 +145417,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145157,9 +145508,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145253,9 +145604,9 @@ x-webhooks: type: number blocking_issue: *227 blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145348,9 +145699,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145444,9 +145795,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -145531,10 +145882,10 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - issue: &878 + assignee: *872 + enterprise: *845 + installation: *846 + issue: &879 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146323,11 +146674,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146444,8 +146795,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -146525,8 +146876,8 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147320,11 +147671,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147576,8 +147927,8 @@ x-webhooks: required: - state - closed_at - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -147656,8 +148007,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148442,11 +148793,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148562,8 +148913,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -148642,8 +148993,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149450,11 +149801,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149549,7 +149900,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &876 + milestone: &877 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149687,8 +150038,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -149787,8 +150138,8 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150577,11 +150928,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150698,9 +151049,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -150780,8 +151131,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151569,11 +151920,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151690,9 +152041,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -151772,8 +152123,8 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152585,11 +152936,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152683,8 +153034,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -152763,8 +153114,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153570,11 +153921,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153668,9 +154019,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *876 - organization: *846 - repository: *847 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -154538,11 +154889,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155104,8 +155455,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155894,11 +156245,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156014,8 +156365,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -156095,9 +156446,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *844 - installation: *845 - issue: &877 + enterprise: *845 + installation: *846 + issue: &878 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -156880,11 +157231,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157000,8 +157351,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -157080,8 +157431,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157891,11 +158242,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157990,8 +158341,8 @@ x-webhooks: user_view_type: type: string type: *360 - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -158857,11 +159208,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159445,11 +159796,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *878 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159529,12 +159880,12 @@ x-webhooks: type: string enum: - typed - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *845 + installation: *846 + issue: *879 type: *360 - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159615,7 +159966,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &907 + assignee: &908 title: User type: object nullable: true @@ -159685,11 +160036,11 @@ x-webhooks: required: - login - id - enterprise: *844 - installation: *845 - issue: *878 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *879 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159768,12 +160119,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - issue: *878 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *879 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -159853,8 +160204,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -160664,11 +161015,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160762,8 +161113,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -160843,11 +161194,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + issue: *878 + organization: *847 + repository: *848 sender: *4 required: - action @@ -160926,12 +161277,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *844 - installation: *845 - issue: *878 + enterprise: *845 + installation: *846 + issue: *879 type: *360 - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161011,11 +161362,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161093,11 +161444,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161207,11 +161558,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + label: *866 + organization: *847 + repository: *848 sender: *4 required: - action @@ -161293,9 +161644,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: &879 + enterprise: *845 + installation: *846 + marketplace_purchase: &880 title: Marketplace Purchase type: object required: @@ -161378,8 +161729,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: &880 + organization: *847 + previous_marketplace_purchase: &881 title: Marketplace Purchase type: object properties: @@ -161459,7 +161810,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *848 sender: *4 required: - action @@ -161539,10 +161890,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *845 + installation: *846 + marketplace_purchase: *880 + organization: *847 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161625,7 +161976,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *848 sender: *4 required: - action @@ -161707,10 +162058,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *845 + installation: *846 + marketplace_purchase: *880 + organization: *847 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161792,7 +162143,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *848 sender: *4 required: - action @@ -161873,8 +162224,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 marketplace_purchase: title: Marketplace Purchase type: object @@ -161956,9 +162307,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + organization: *847 + previous_marketplace_purchase: *881 + repository: *848 sender: *4 required: - action @@ -162038,12 +162389,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + enterprise: *845 + installation: *846 + marketplace_purchase: *880 + organization: *847 + previous_marketplace_purchase: *881 + repository: *848 sender: *4 required: - action @@ -162145,11 +162496,11 @@ x-webhooks: type: string required: - to - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162249,11 +162600,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162332,11 +162683,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162414,11 +162765,11 @@ x-webhooks: type: string enum: - added - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162494,7 +162845,7 @@ x-webhooks: required: - login - id - team: &881 + team: &882 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162717,11 +163068,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + member: *872 + organization: *847 + repository: *848 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162798,7 +163149,7 @@ x-webhooks: required: - login - id - team: *881 + team: *882 required: - action - scope @@ -162880,8 +163231,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *845 - merge_group: &883 + installation: *846 + merge_group: &884 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162900,15 +163251,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *882 + head_commit: *883 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -162994,10 +163345,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *845 - merge_group: *883 - organization: *846 - repository: *847 + installation: *846 + merge_group: *884 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163070,7 +163421,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *845 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163179,16 +163530,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *845 - organization: *846 + installation: *846 + organization: *847 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -163269,11 +163620,11 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163352,9 +163703,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - milestone: &886 + enterprise: *845 + installation: *846 + milestone: &887 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163491,8 +163842,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163571,11 +163922,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163685,11 +164036,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *877 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163769,11 +164120,11 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - milestone: *886 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + milestone: *887 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163852,11 +164203,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *872 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -163935,11 +164286,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *872 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164015,7 +164366,7 @@ x-webhooks: enum: - created definition: *146 - enterprise: *844 + enterprise: *845 sender: *4 required: - action @@ -164095,8 +164446,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 sender: *4 required: - action @@ -164169,8 +164520,8 @@ x-webhooks: enum: - updated definition: *146 - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 sender: *4 required: - action @@ -164242,9 +164593,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 new_property_values: type: array @@ -164332,9 +164683,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - membership: &887 + enterprise: *845 + installation: *846 + membership: &888 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164441,8 +164792,8 @@ x-webhooks: - role - organization_url - user - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164520,11 +164871,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + membership: *888 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164603,8 +164954,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164720,10 +165071,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 - user: *871 + user: *872 required: - action - invitation @@ -164801,11 +165152,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + membership: *888 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164892,11 +165243,11 @@ x-webhooks: properties: from: type: string - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + membership: *888 + organization: *847 + repository: *848 sender: *4 required: - action @@ -164972,9 +165323,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 package: description: Information about the package. type: object @@ -165473,7 +165824,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &889 title: Ruby Gems metadata type: object properties: @@ -165568,7 +165919,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -165644,9 +165995,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 package: description: Information about the package. type: object @@ -165999,7 +166350,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *889 source_url: type: string format: uri @@ -166069,7 +166420,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -166246,12 +166597,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *844 + enterprise: *845 id: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - id @@ -166328,7 +166679,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &890 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166474,10 +166825,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *844 - organization: *846 + enterprise: *845 + organization: *847 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166554,11 +166905,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *890 + enterprise: *845 + organization: *847 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166634,11 +166985,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *890 + enterprise: *845 + organization: *847 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166713,11 +167064,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *846 - enterprise: *844 + personal_access_token_request: *890 + organization: *847 + enterprise: *845 sender: *4 - installation: *845 + installation: *846 required: - action - personal_access_token_request @@ -166822,7 +167173,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *891 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166854,8 +167205,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 zen: description: Random string of GitHub zen. @@ -167100,10 +167451,10 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: &891 + enterprise: *845 + installation: *846 + organization: *847 + project_card: &892 title: Project Card type: object properties: @@ -167222,7 +167573,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *848 sender: *4 required: - action @@ -167303,11 +167654,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_card: *892 + repository: *848 sender: *4 required: - action @@ -167387,9 +167738,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 project_card: title: Project Card type: object @@ -167517,8 +167868,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -167612,11 +167963,11 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_card: *892 + repository: *848 sender: *4 required: - action @@ -167710,9 +168061,9 @@ x-webhooks: - from required: - column_id - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 project_card: allOf: - title: Project Card @@ -167902,7 +168253,7 @@ x-webhooks: type: string required: - after_id - repository: *847 + repository: *848 sender: *4 required: - action @@ -167982,10 +168333,10 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - organization: *846 - project: &893 + enterprise: *845 + installation: *846 + organization: *847 + project: &894 title: Project type: object properties: @@ -168109,7 +168460,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *848 sender: *4 required: - action @@ -168189,10 +168540,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_column: &892 + enterprise: *845 + installation: *846 + organization: *847 + project_column: &893 title: Project Column type: object properties: @@ -168231,7 +168582,7 @@ x-webhooks: - name - created_at - updated_at - repository: *847 + repository: *848 sender: *4 required: - action @@ -168310,18 +168661,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 + enterprise: *845 + installation: *846 + organization: *847 + project_column: *893 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -168411,11 +168762,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_column: *893 + repository: *848 sender: *4 required: - action @@ -168495,11 +168846,11 @@ x-webhooks: type: string enum: - moved - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project_column: *893 + repository: *848 sender: *4 required: - action @@ -168579,11 +168930,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 + repository: *848 sender: *4 required: - action @@ -168663,18 +169014,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project: *893 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *885 + required: *886 nullable: true sender: *4 required: @@ -168776,11 +169127,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 + repository: *848 sender: *4 required: - action @@ -168859,11 +169210,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + project: *894 + repository: *848 sender: *4 required: - action @@ -168944,8 +169295,8 @@ x-webhooks: type: string enum: - closed - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169027,8 +169378,8 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169110,8 +169461,8 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169229,8 +169580,8 @@ x-webhooks: type: string to: type: string - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -169314,7 +169665,7 @@ x-webhooks: type: string enum: - archived - changes: &897 + changes: &898 type: object properties: archived_at: @@ -169328,9 +169679,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *845 - organization: *846 - projects_v2_item: &894 + installation: *846 + organization: *847 + projects_v2_item: &895 title: Projects v2 Item description: An item belonging to a project type: object @@ -169465,9 +169816,9 @@ x-webhooks: nullable: true to: type: string - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169549,9 +169900,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169632,9 +169983,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169740,7 +170091,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &895 + - &896 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169762,7 +170113,7 @@ x-webhooks: required: - id - name - - &896 + - &897 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169796,8 +170147,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *895 - *896 + - *897 required: - field_value - type: object @@ -169813,9 +170164,9 @@ x-webhooks: nullable: true required: - body - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169910,9 +170261,9 @@ x-webhooks: to: type: string nullable: true - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -169995,10 +170346,10 @@ x-webhooks: type: string enum: - restored - changes: *897 - installation: *845 - organization: *846 - projects_v2_item: *894 + changes: *898 + installation: *846 + organization: *847 + projects_v2_item: *895 sender: *4 required: - action @@ -170080,8 +170431,8 @@ x-webhooks: type: string enum: - reopened - installation: *845 - organization: *846 + installation: *846 + organization: *847 projects_v2: *392 sender: *4 required: @@ -170163,14 +170514,14 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_status_update: &900 + installation: *846 + organization: *847 + projects_v2_status_update: &901 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *898 - required: *899 + properties: *899 + required: *900 sender: *4 required: - action @@ -170251,9 +170602,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *846 + organization: *847 + projects_v2_status_update: *901 sender: *4 required: - action @@ -170389,9 +170740,9 @@ x-webhooks: type: string format: date nullable: true - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *846 + organization: *847 + projects_v2_status_update: *901 sender: *4 required: - action @@ -170462,10 +170813,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - repository @@ -170542,13 +170893,13 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - number: &901 + assignee: *872 + enterprise: *845 + installation: *846 + number: &902 description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -172831,7 +173182,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -172913,11 +173264,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -175195,7 +175546,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *848 sender: *4 required: - action @@ -175277,11 +175628,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -177559,7 +177910,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *848 sender: *4 required: - action @@ -177641,13 +177992,13 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: &902 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: &903 allOf: - - *695 + - *696 - type: object properties: allow_auto_merge: @@ -177709,7 +178060,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *847 + repository: *848 sender: *4 required: - action @@ -177790,12 +178141,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -177875,11 +178226,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: &903 + enterprise: *845 + milestone: *678 + number: *902 + organization: *847 + pull_request: &904 title: Pull Request type: object properties: @@ -180142,7 +180493,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -180221,11 +180572,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -182507,7 +182858,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *847 + repository: *848 sender: *4 required: - action @@ -182631,12 +182982,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -182716,11 +183067,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -184987,7 +185338,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -185067,11 +185418,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + label: *866 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -187353,7 +187704,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -187434,10 +187785,10 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -189717,7 +190068,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -189797,12 +190148,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: *903 - repository: *847 + enterprise: *845 + milestone: *678 + number: *902 + organization: *847 + pull_request: *904 + repository: *848 sender: *4 required: - action @@ -189881,12 +190232,12 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -189967,12 +190318,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -190052,12 +190403,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 + pull_request: *903 + repository: *848 sender: *4 required: - action @@ -190423,9 +190774,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: type: object properties: @@ -192595,7 +192946,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *848 sender: *4 required: - action @@ -192675,7 +193026,7 @@ x-webhooks: type: string enum: - deleted - comment: &905 + comment: &906 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. @@ -192960,9 +193311,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: type: object properties: @@ -195120,7 +195471,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *848 sender: *4 required: - action @@ -195200,11 +195551,11 @@ x-webhooks: type: string enum: - edited - changes: *904 - comment: *905 - enterprise: *844 - installation: *845 - organization: *846 + changes: *905 + comment: *906 + enterprise: *845 + installation: *846 + organization: *847 pull_request: type: object properties: @@ -197365,7 +197716,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *848 sender: *4 required: - action @@ -197446,9 +197797,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -199621,7 +199972,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *848 review: description: The review that was affected. type: object @@ -199868,9 +200219,9 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -201924,8 +202275,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: &906 + repository: *848 + review: &907 description: The review that was affected. type: object properties: @@ -202158,12 +202509,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -204446,7 +204797,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_reviewer: title: User type: object @@ -204530,12 +204881,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -206825,7 +207176,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207017,12 +207368,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -209307,7 +209658,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_reviewer: title: User type: object @@ -209392,12 +209743,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *845 + installation: *846 number: description: The pull request number. type: integer - organization: *846 + organization: *847 pull_request: title: Pull Request type: object @@ -211673,7 +212024,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211854,9 +212205,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -214031,8 +214382,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: *906 + repository: *848 + review: *907 sender: *4 required: - action @@ -214112,9 +214463,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -216184,7 +216535,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *848 sender: *4 thread: type: object @@ -216571,9 +216922,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 pull_request: title: Simple Pull Request type: object @@ -218629,7 +218980,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *848 sender: *4 thread: type: object @@ -219019,10 +219370,10 @@ x-webhooks: type: string before: type: string - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -221293,7 +221644,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -221375,11 +221726,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *907 - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + assignee: *908 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -223662,7 +224013,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -223741,11 +224092,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + label: *866 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -226018,7 +226369,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -226099,10 +226450,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *845 + installation: *846 + number: *902 + organization: *847 pull_request: title: Pull Request type: object @@ -228367,7 +228718,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *848 sender: *4 required: - action @@ -228567,7 +228918,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *844 + enterprise: *845 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228659,8 +229010,8 @@ x-webhooks: - url - author - committer - installation: *845 - organization: *846 + installation: *846 + organization: *847 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229235,9 +229586,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 registry_package: type: object properties: @@ -229683,7 +230034,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *889 summary: type: string tag_name: @@ -229737,7 +230088,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -229815,9 +230166,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 registry_package: type: object properties: @@ -230125,7 +230476,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *889 summary: type: string tag_name: @@ -230174,7 +230525,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *848 sender: *4 required: - action @@ -230251,10 +230602,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - release: &908 + enterprise: *845 + installation: *846 + organization: *847 + release: &909 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -230572,7 +230923,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *847 + repository: *848 sender: *4 required: - action @@ -230649,11 +231000,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *909 + repository: *848 sender: *4 required: - action @@ -230770,11 +231121,11 @@ x-webhooks: type: boolean required: - to - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *909 + repository: *848 sender: *4 required: - action @@ -230852,9 +231203,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231176,7 +231527,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *848 sender: *4 required: - action @@ -231252,10 +231603,10 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - release: &909 + enterprise: *845 + installation: *846 + organization: *847 + release: &910 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231574,7 +231925,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *848 sender: *4 required: - action @@ -231650,11 +232001,11 @@ x-webhooks: type: string enum: - released - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *909 + repository: *848 sender: *4 required: - action @@ -231730,11 +232081,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *844 - installation: *845 - organization: *846 - release: *909 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + release: *910 + repository: *848 sender: *4 required: - action @@ -231810,11 +232161,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + repository_advisory: *749 sender: *4 required: - action @@ -231890,11 +232241,11 @@ x-webhooks: type: string enum: - reported - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + repository_advisory: *749 sender: *4 required: - action @@ -231970,10 +232321,10 @@ x-webhooks: type: string enum: - archived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232050,10 +232401,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232131,10 +232482,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232218,10 +232569,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232333,10 +232684,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232408,10 +232759,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 status: type: string @@ -232492,10 +232843,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232572,10 +232923,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232669,10 +233020,10 @@ x-webhooks: - name required: - repository - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -232752,10 +233103,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 repository_ruleset: *185 sender: *4 required: @@ -232834,10 +233185,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 repository_ruleset: *185 sender: *4 required: @@ -232916,10 +233267,10 @@ x-webhooks: type: string enum: - edited - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 repository_ruleset: *185 changes: type: object @@ -232981,16 +233332,16 @@ x-webhooks: properties: added: type: array - items: *716 + items: *717 deleted: type: array - items: *716 + items: *717 updated: type: array items: type: object properties: - rule: *716 + rule: *717 changes: type: object properties: @@ -233224,10 +233575,10 @@ x-webhooks: - from required: - owner - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233305,10 +233656,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233386,7 +233737,7 @@ x-webhooks: type: string enum: - create - alert: &910 + alert: &911 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233507,10 +233858,10 @@ x-webhooks: type: string enum: - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233716,10 +234067,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -233797,11 +234148,11 @@ x-webhooks: type: string enum: - reopen - alert: *910 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *911 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234000,10 +234351,10 @@ x-webhooks: enum: - fixed - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234021,7 +234372,7 @@ x-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. @@ -234029,8 +234380,8 @@ x-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: @@ -234074,14 +234425,14 @@ x-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: &911 + - assigned + alert: &912 type: object properties: number: *123 @@ -234199,10 +234550,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + assignee: *4 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + 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: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234283,11 +234717,11 @@ x-webhooks: type: string enum: - created - alert: *911 - installation: *845 - location: *912 - organization: *846 - repository: *847 + alert: *912 + installation: *846 + location: *913 + organization: *847 + repository: *848 sender: *4 required: - location @@ -234525,11 +234959,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234607,11 +235041,11 @@ x-webhooks: type: string enum: - reopened - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234689,11 +235123,94 @@ x-webhooks: type: string enum: - resolved - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + 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: *912 + assignee: *4 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234771,11 +235288,11 @@ x-webhooks: type: string enum: - validated - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *912 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -234901,10 +235418,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *847 - enterprise: *844 - installation: *845 - organization: *846 + repository: *848 + enterprise: *845 + installation: *846 + organization: *847 sender: *4 required: - action @@ -234982,11 +235499,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: &913 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + security_advisory: &914 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235169,11 +235686,11 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: *913 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 + security_advisory: *914 sender: *4 required: - action @@ -235246,10 +235763,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235434,10 +235951,10 @@ x-webhooks: type: object properties: security_and_analysis: *408 - enterprise: *844 - installation: *845 - organization: *846 - repository: *467 + enterprise: *845 + installation: *846 + organization: *847 + repository: *468 sender: *4 required: - changes @@ -235515,12 +236032,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: &914 + sponsorship: &915 type: object properties: created_at: @@ -235821,12 +236338,12 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - sponsorship @@ -235914,12 +236431,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - changes @@ -235996,17 +236513,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &915 + effective_date: &916 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: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - sponsorship @@ -236080,7 +236597,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &916 + changes: &917 type: object properties: tier: @@ -236124,13 +236641,13 @@ x-webhooks: - from required: - tier - effective_date: *915 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + effective_date: *916 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - changes @@ -236207,13 +236724,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *916 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + changes: *917 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - sponsorship: *914 + sponsorship: *915 required: - action - changes @@ -236287,10 +236804,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236373,10 +236890,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236796,15 +237313,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *844 + enterprise: *845 id: description: The unique identifier of the status. type: integer - installation: *845 + installation: *846 name: type: string - organization: *846 - repository: *847 + organization: *847 + repository: *848 sender: *4 sha: description: The Commit SHA. @@ -236919,9 +237436,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237011,9 +237528,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237103,9 +237620,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237195,9 +237712,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -237274,12 +237791,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - team: &917 + team: &918 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237502,9 +238019,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -237962,7 +238479,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -238038,9 +238555,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -238498,7 +239015,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -238575,9 +239092,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -239035,7 +239552,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -239179,9 +239696,9 @@ x-webhooks: - from required: - permissions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -239639,7 +240156,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - changes @@ -239717,9 +240234,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *845 + installation: *846 + organization: *847 repository: title: Repository description: A git repository @@ -240177,7 +240694,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *918 required: - action - team @@ -240253,10 +240770,10 @@ x-webhooks: type: string enum: - started - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 required: - action @@ -240329,16 +240846,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *844 + enterprise: *845 inputs: type: object nullable: true additionalProperties: true - installation: *845 - organization: *846 + installation: *846 + organization: *847 ref: type: string - repository: *847 + repository: *848 sender: *4 workflow: type: string @@ -240420,10 +240937,10 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: allOf: @@ -240660,7 +241177,7 @@ x-webhooks: type: string required: - conclusion - deployment: *599 + deployment: *600 required: - action - repository @@ -240739,10 +241256,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: allOf: @@ -241002,7 +241519,7 @@ x-webhooks: required: - status - steps - deployment: *599 + deployment: *600 required: - action - repository @@ -241081,10 +241598,10 @@ x-webhooks: type: string enum: - queued - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: type: object @@ -241219,7 +241736,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *600 required: - action - repository @@ -241298,10 +241815,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 workflow_job: type: object @@ -241437,7 +241954,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *600 required: - action - repository @@ -241517,12 +242034,12 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Workflow Run type: object @@ -242521,12 +243038,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Workflow Run type: object @@ -243510,12 +244027,12 @@ x-webhooks: type: string enum: - requested - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *845 + installation: *846 + organization: *847 + repository: *848 sender: *4 - workflow: *861 + workflow: *862 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 3e7792ece..3e124481a 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -11582,6 +11582,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -37810,6 +37813,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -74937,6 +74943,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75063,7 +75072,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" @@ -75098,6 +75107,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -75105,6 +75117,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -75114,6 +75131,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -75142,7 +75171,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" @@ -90573,6 +90602,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}": { @@ -114094,6 +114318,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.", @@ -114389,11 +114706,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" }, @@ -114460,7 +114870,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -114482,11 +114892,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" }, @@ -114553,7 +114963,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -119076,6 +119486,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.", @@ -143599,6 +144017,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -153922,6 +154341,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -173801,6 +174225,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -174604,6 +175035,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -288499,6 +288937,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", @@ -288688,6 +289164,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", @@ -304167,7 +304681,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": { @@ -310158,21 +310687,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", @@ -326084,7 +326631,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": { @@ -331204,6 +331771,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": [ { @@ -333505,6 +334260,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/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index b38126a1f..c9da56cc1 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -8291,6 +8291,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" @@ -27266,6 +27267,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" @@ -54241,6 +54243,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" @@ -54320,6 +54323,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. @@ -54346,14 +54351,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 @@ -54371,7 +54388,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: @@ -65489,6 +65507,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 @@ -82235,6 +82391,72 @@ x-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: |- @@ -82578,6 +82800,72 @@ x-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: |- @@ -85866,6 +86154,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 @@ -105266,6 +105561,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -113083,6 +113379,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -128207,6 +128508,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -128820,6 +129126,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -214556,6 +214867,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 @@ -214687,6 +215024,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 @@ -227028,7 +227391,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. @@ -232147,17 +232522,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: @@ -245854,6 +246241,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 @@ -250207,6 +250613,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' @@ -252267,6 +252805,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/ghec/ghec.json b/descriptions/ghec/ghec.json index 3e7792ece..3e124481a 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -11582,6 +11582,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -37810,6 +37813,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -74937,6 +74943,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75063,7 +75072,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" @@ -75098,6 +75107,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -75105,6 +75117,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -75114,6 +75131,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -75142,7 +75171,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" @@ -90573,6 +90602,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}": { @@ -114094,6 +114318,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.", @@ -114389,11 +114706,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" }, @@ -114460,7 +114870,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -114482,11 +114892,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" }, @@ -114553,7 +114963,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -119076,6 +119486,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.", @@ -143599,6 +144017,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -153922,6 +154341,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -173801,6 +174225,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -174604,6 +175035,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -288499,6 +288937,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", @@ -288688,6 +289164,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", @@ -304167,7 +304681,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": { @@ -310158,21 +310687,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", @@ -326084,7 +326631,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": { @@ -331204,6 +331771,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": [ { @@ -333505,6 +334260,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/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index b38126a1f..c9da56cc1 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -8291,6 +8291,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" @@ -27266,6 +27267,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" @@ -54241,6 +54243,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" @@ -54320,6 +54323,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. @@ -54346,14 +54351,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 @@ -54371,7 +54388,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: @@ -65489,6 +65507,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 @@ -82235,6 +82391,72 @@ x-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: |- @@ -82578,6 +82800,72 @@ x-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: |- @@ -85866,6 +86154,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 @@ -105266,6 +105561,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -113083,6 +113379,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -128207,6 +128508,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -128820,6 +129126,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -214556,6 +214867,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 @@ -214687,6 +215024,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 @@ -227028,7 +227391,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. @@ -232147,17 +232522,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: @@ -245854,6 +246241,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 @@ -250207,6 +250613,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' @@ -252267,6 +252805,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/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index e93f13076..aff6e60ed 100644 --- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -4098,6 +4098,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.", @@ -5362,6 +5370,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.", @@ -6203,6 +6219,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.", @@ -11151,6 +11175,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.", @@ -12119,6 +12151,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.", @@ -12941,6 +12981,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.", @@ -13394,6 +13442,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.", @@ -16161,6 +16217,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.", @@ -17180,6 +17244,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.", @@ -18116,6 +18188,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.", @@ -18763,6 +18843,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.", @@ -20296,6 +20384,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.", @@ -21325,6 +21421,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.", @@ -22423,6 +22527,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.", @@ -23272,6 +23384,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.", @@ -24348,6 +24468,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.", @@ -25197,6 +25325,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.", @@ -26151,6 +26287,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.", @@ -27146,6 +27290,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.", @@ -96222,6 +96374,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.", @@ -97205,6 +97365,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.", @@ -184421,6 +184589,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -184441,6 +184610,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -202575,6 +202745,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -202595,6 +202766,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224849,6 +225021,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224869,6 +225042,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -230597,6 +230771,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -230617,6 +230792,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -235506,6 +235682,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -235526,6 +235703,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -236047,6 +236225,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -236067,6 +236246,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -236612,6 +236792,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -236632,6 +236813,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -267997,6 +268179,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.", @@ -326394,6 +326584,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -326414,6 +326605,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -354831,6 +355023,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -354851,6 +355044,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -384861,9 +385055,6 @@ "state" ] } - ], - "required": [ - "state" ] }, "examples": { @@ -402797,6 +402988,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -403004,6 +403196,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -425905,6 +426098,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.", @@ -465448,6 +465649,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.", @@ -518894,6 +519103,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -521291,6 +521507,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -629454,6 +629677,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.", @@ -632045,6 +632276,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.", @@ -634543,6 +634782,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.", @@ -637041,6 +637288,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.", @@ -639671,6 +639926,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.", @@ -642308,6 +642571,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}