summaryrefslogtreecommitdiffstats
path: root/descriptions/api.github.com
diff options
context:
space:
mode:
Diffstat (limited to 'descriptions/api.github.com')
-rw-r--r--descriptions/api.github.com/api.github.com.2022-11-28.json1131
-rw-r--r--descriptions/api.github.com/api.github.com.2022-11-28.yaml881
-rw-r--r--descriptions/api.github.com/api.github.com.json1131
-rw-r--r--descriptions/api.github.com/api.github.com.yaml881
-rw-r--r--descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json2741
-rw-r--r--descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml9262
-rw-r--r--descriptions/api.github.com/dereferenced/api.github.com.deref.json2741
-rw-r--r--descriptions/api.github.com/dereferenced/api.github.com.deref.yaml9262
8 files changed, 18396 insertions, 9634 deletions
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 3ded5679d..b76ea3869 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
@@ -179,6 +179,10 @@
{
"name": "hosted-compute",
"description": "Manage hosted compute networking resources."
+ },
+ {
+ "name": "campaigns",
+ "description": "Endpoints to manage campaigns via the REST API."
}
],
"servers": [
@@ -10657,6 +10661,526 @@
}
}
},
+ "/orgs/{org}/campaigns": {
+ "get": {
+ "summary": "List campaigns for an organization",
+ "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/list-org-campaigns",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "state",
+ "description": "If specified, only campaigns with this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/campaign-state"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "ends_at",
+ "published"
+ ],
+ "default": "created"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/campaign-summary"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-org-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "post": {
+ "summary": "Create a campaign for an organization",
+ "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/create-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The login of each manager",
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign. The date must be in the future.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "code_scanning_alerts": {
+ "description": "The code scanning alerts to include in this campaign",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "repository_id": {
+ "type": "integer",
+ "description": "The repository id"
+ },
+ "alert_numbers": {
+ "type": "array",
+ "description": "The alert numbers",
+ "minItems": 1,
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "repository_id",
+ "alert_numbers"
+ ]
+ }
+ },
+ "generate_issues": {
+ "description": "If true, will automatically generate issues for the campaign. The default is false.",
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "ends_at",
+ "code_scanning_alerts"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ "octocat"
+ ],
+ "ends_at": "2024-03-14T00:00:00Z",
+ "code_scanning_alerts": [
+ {
+ "repository_id": 1296269,
+ "alert_numbers": [
+ 1,
+ 2
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/campaign-summary"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-summary"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too Many Requests"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
+ "/orgs/{org}/campaigns/{campaign_number}": {
+ "get": {
+ "summary": "Get a campaign for an organization",
+ "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/get-campaign-summary",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/campaign-summary"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-summary"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "patch": {
+ "summary": "Update a campaign",
+ "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/update-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "state": {
+ "$ref": "#/components/schemas/campaign-state"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/campaign-summary"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-summary"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "delete": {
+ "summary": "Delete a campaign for an organization",
+ "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/delete-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Deletion successful"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
"/orgs/{org}/code-scanning/alerts": {
"get": {
"summary": "List code scanning alerts for an organization",
@@ -102880,6 +103404,291 @@
"visibility"
]
},
+ "campaign-state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "nullable-team-simple": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/nullable-team-simple"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ },
+ "campaign-summary": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "$ref": "#/components/schemas/campaign-state"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
"code-scanning-analysis-tool-name": {
"type": "string",
"description": "The name of the tool used to generate the code scanning analysis."
@@ -103754,181 +104563,6 @@
],
"nullable": true
},
- "nullable-team-simple": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug"
- ],
- "nullable": true
- },
- "team": {
- "title": "Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "node_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "slug": {
- "type": "string"
- },
- "description": {
- "type": "string",
- "nullable": true
- },
- "privacy": {
- "type": "string"
- },
- "notification_setting": {
- "type": "string"
- },
- "permission": {
- "type": "string"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "pull",
- "triage",
- "push",
- "maintain",
- "admin"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "members_url": {
- "type": "string"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri"
- },
- "parent": {
- "$ref": "#/components/schemas/nullable-team-simple"
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "parent"
- ]
- },
"enterprise-team": {
"title": "Enterprise Team",
"description": "Group of enterprise owners and/or members",
@@ -108299,7 +108933,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -119338,6 +119972,12 @@
"type": "array",
"items": {
"type": "object",
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha"
+ ],
"properties": {
"path": {
"type": "string",
@@ -119372,42 +120012,13 @@
"type": "blob",
"size": 30,
"sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "path",
- "mode",
- "type",
- "sha",
- "url",
- "size"
- ]
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
}
]
}
},
"required": [
"sha",
- "url",
"tree",
"truncated"
]
@@ -273652,6 +274263,114 @@
}
]
},
+ "campaign-org-items": {
+ "value": [
+ {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ },
+ {
+ "number": 4,
+ "created_at": "2024-03-30T12:29:18Z",
+ "updated_at": "2024-03-30T12:29:18Z",
+ "name": "Mitre top 10 KEV",
+ "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-04-30T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ }
+ ]
+ },
+ "campaign-summary": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ },
"code-scanning-organization-alert-items": {
"value": [
{
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 3a08d9a6e..0be3e65de 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
@@ -95,6 +95,8 @@ tags:
description: Manage private registry configurations.
- name: hosted-compute
description: Manage hosted compute networking resources.
+- name: campaigns
+ description: Endpoints to manage campaigns via the REST API.
servers:
- url: https://api.github.com
externalDocs:
@@ -7716,6 +7718,391 @@ paths:
enabledForGitHubApps: true
category: orgs
subcategory: blocking
+ "/orgs/{org}/campaigns":
+ get:
+ summary: List campaigns for an organization
+ description: |-
+ Lists campaigns in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/list-org-campaigns
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ - "$ref": "#/components/parameters/direction"
+ - name: state
+ description: If specified, only campaigns with this state will be returned.
+ in: query
+ required: false
+ schema:
+ "$ref": "#/components/schemas/campaign-state"
+ - name: sort
+ description: The property by which to sort the results.
+ in: query
+ required: false
+ schema:
+ type: string
+ enum:
+ - created
+ - updated
+ - ends_at
+ - published
+ default: created
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-org-items"
+ headers:
+ Link:
+ "$ref": "#/components/headers/link"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ post:
+ summary: Create a campaign for an organization
+ description: |-
+ Create a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+
+ Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
+ in the campaign.
+ tags:
+ - campaigns
+ operationId: campaigns/create-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ description: The login of each manager
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign. The date must
+ be in the future.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ code_scanning_alerts:
+ description: The code scanning alerts to include in this campaign
+ type: array
+ minItems: 1
+ items:
+ type: object
+ additionalProperties: false
+ properties:
+ repository_id:
+ type: integer
+ description: The repository id
+ alert_numbers:
+ type: array
+ description: The alert numbers
+ minItems: 1
+ items:
+ type: integer
+ required:
+ - repository_id
+ - alert_numbers
+ generate_issues:
+ description: If true, will automatically generate issues for the
+ campaign. The default is false.
+ type: boolean
+ default: false
+ required:
+ - name
+ - description
+ - ends_at
+ - code_scanning_alerts
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ description: Address critical alerts before they are exploited to
+ prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - octocat
+ ends_at: '2024-03-14T00:00:00Z'
+ code_scanning_alerts:
+ - repository_id: 1296269
+ alert_numbers:
+ - 1
+ - 2
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-summary"
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '429':
+ description: Too Many Requests
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ "/orgs/{org}/campaigns/{campaign_number}":
+ get:
+ summary: Get a campaign for an organization
+ description: |-
+ Gets a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/get-campaign-summary
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-summary"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ patch:
+ summary: Update a campaign
+ description: |-
+ Updates a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/update-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign, in ISO 8601
+ format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ state:
+ "$ref": "#/components/schemas/campaign-state"
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-summary"
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ delete:
+ summary: Delete a campaign for an organization
+ description: |-
+ Deletes a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/delete-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '204':
+ description: Deletion successful
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
"/orgs/{org}/code-scanning/alerts":
get:
summary: List code scanning alerts for an organization
@@ -75075,6 +75462,233 @@ components:
- created_at
- updated_at
- visibility
+ campaign-state:
+ title: Campaign state
+ description: Indicates whether a campaign is open or closed
+ type: string
+ enum:
+ - open
+ - closed
+ nullable-team-simple:
+ title: Team Simple
+ description: Groups of organization members that gives permissions on specified
+ repositories.
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the team
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDQ6VGVhbTE=
+ url:
+ description: URL for the team
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1
+ members_url:
+ type: string
+ example: https://api.github.com/organizations/1/team/1/members{/member}
+ name:
+ description: Name of the team
+ type: string
+ example: Justice League
+ description:
+ description: Description of the team
+ type: string
+ nullable: true
+ example: A great team.
+ permission:
+ description: Permission that the team will have for its repositories
+ type: string
+ example: admin
+ privacy:
+ description: The level of privacy this team should have
+ type: string
+ example: closed
+ notification_setting:
+ description: The notification setting the team has set
+ type: string
+ example: notifications_enabled
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ repositories_url:
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1/repos
+ slug:
+ type: string
+ example: justice-league
+ ldap_dn:
+ description: Distinguished Name (DN) that team maps to within LDAP environment
+ example: uid=example,ou=users,dc=github,dc=com
+ type: string
+ required:
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ nullable: true
+ team:
+ title: Team
+ description: Groups of organization members that gives permissions on specified
+ repositories.
+ type: object
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ slug:
+ type: string
+ description:
+ type: string
+ nullable: true
+ privacy:
+ type: string
+ notification_setting:
+ type: string
+ permission:
+ type: string
+ permissions:
+ type: object
+ properties:
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ admin:
+ type: boolean
+ required:
+ - pull
+ - triage
+ - push
+ - maintain
+ - admin
+ url:
+ type: string
+ format: uri
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ members_url:
+ type: string
+ repositories_url:
+ type: string
+ format: uri
+ parent:
+ "$ref": "#/components/schemas/nullable-team-simple"
+ required:
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ - parent
+ campaign-summary:
+ title: Campaign summary
+ description: The campaign metadata and alert stats.
+ type: object
+ properties:
+ number:
+ type: integer
+ description: The number of the newly created campaign
+ created_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was created, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ.
+ updated_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was last updated, in ISO 8601
+ format':' YYYY-MM-DDTHH:MM:SSZ.
+ name:
+ type: string
+ description: The campaign name
+ description:
+ type: string
+ description: The campaign description
+ managers:
+ description: The campaign managers
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-user"
+ team_managers:
+ description: The campaign team managers
+ type: array
+ items:
+ "$ref": "#/components/schemas/team"
+ published_at:
+ description: The date and time the campaign was published, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ ends_at:
+ description: The date and time the campaign has ended, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ closed_at:
+ description: The date and time the campaign was closed, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.
+ type: string
+ format: date-time
+ nullable: true
+ state:
+ "$ref": "#/components/schemas/campaign-state"
+ contact_link:
+ description: The contact link of the campaign.
+ type: string
+ format: uri
+ nullable: true
+ alert_stats:
+ type: object
+ additionalProperties: false
+ properties:
+ open_count:
+ type: integer
+ description: The number of open alerts
+ closed_count:
+ type: integer
+ description: The number of closed alerts
+ in_progress_count:
+ type: integer
+ description: The number of in-progress alerts
+ required:
+ - open_count
+ - closed_count
+ - in_progress_count
+ required:
+ - number
+ - created_at
+ - updated_at
+ - description
+ - managers
+ - ends_at
+ - state
+ - contact_link
code-scanning-analysis-tool-name:
type: string
description: The name of the tool used to generate the code scanning analysis.
@@ -75801,143 +76415,6 @@ components:
- avatar_url
- description
nullable: true
- nullable-team-simple:
- title: Team Simple
- description: Groups of organization members that gives permissions on specified
- repositories.
- type: object
- properties:
- id:
- description: Unique identifier of the team
- type: integer
- example: 1
- node_id:
- type: string
- example: MDQ6VGVhbTE=
- url:
- description: URL for the team
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1
- members_url:
- type: string
- example: https://api.github.com/organizations/1/team/1/members{/member}
- name:
- description: Name of the team
- type: string
- example: Justice League
- description:
- description: Description of the team
- type: string
- nullable: true
- example: A great team.
- permission:
- description: Permission that the team will have for its repositories
- type: string
- example: admin
- privacy:
- description: The level of privacy this team should have
- type: string
- example: closed
- notification_setting:
- description: The notification setting the team has set
- type: string
- example: notifications_enabled
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- repositories_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1/repos
- slug:
- type: string
- example: justice-league
- ldap_dn:
- description: Distinguished Name (DN) that team maps to within LDAP environment
- example: uid=example,ou=users,dc=github,dc=com
- type: string
- required:
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- nullable: true
- team:
- title: Team
- description: Groups of organization members that gives permissions on specified
- repositories.
- type: object
- properties:
- id:
- type: integer
- node_id:
- type: string
- name:
- type: string
- slug:
- type: string
- description:
- type: string
- nullable: true
- privacy:
- type: string
- notification_setting:
- type: string
- permission:
- type: string
- permissions:
- type: object
- properties:
- pull:
- type: boolean
- triage:
- type: boolean
- push:
- type: boolean
- maintain:
- type: boolean
- admin:
- type: boolean
- required:
- - pull
- - triage
- - push
- - maintain
- - admin
- url:
- type: string
- format: uri
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- members_url:
- type: string
- repositories_url:
- type: string
- format: uri
- parent:
- "$ref": "#/components/schemas/nullable-team-simple"
- required:
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- - parent
enterprise-team:
title: Enterprise Team
description: Group of enterprise owners and/or members
@@ -79466,11 +79943,8 @@ components:
- rebase
automatic_copilot_code_review_enabled:
type: boolean
- description: |-
- > [!NOTE]
- > `automatic_copilot_code_review_enabled` is in beta and subject to change.
-
- Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.
+ description: Automatically request review from Copilot for new pull
+ requests, if the author has access to Copilot code review.
dismiss_stale_reviews_on_push:
type: boolean
description: New, reviewable commits pushed will dismiss previous pull
@@ -88012,6 +88486,11 @@ components:
type: array
items:
type: object
+ required:
+ - path
+ - mode
+ - type
+ - sha
properties:
path:
type: string
@@ -88038,29 +88517,8 @@ components:
size: 30
sha: 44b4fc6d56897b048c772eb4087f854f46256132
url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132
- properties:
- path:
- type: string
- mode:
- type: string
- type:
- type: string
- size:
- type: integer
- sha:
- type: string
- url:
- type: string
- required:
- - path
- - mode
- - type
- - sha
- - url
- - size
required:
- sha
- - url
- tree
- truncated
hook-response:
@@ -205306,6 +205764,103 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
+ campaign-org-items:
+ value:
+ - number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited to prevent
+ breaches, protect sensitive data, and mitigate financial and reputational
+ damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ - number: 4
+ created_at: '2024-03-30T12:29:18Z'
+ updated_at: '2024-03-30T12:29:18Z'
+ name: Mitre top 10 KEV
+ description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities)
+ to enhance security by addressing vulnerabilities actively exploited by
+ attackers. This reduces risk, prevents breaches and can help protect sensitive
+ data.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-04-30T12:29:18Z'
+ closed_at:
+ state: open
+ campaign-summary:
+ value:
+ number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited to prevent
+ breaches, protect sensitive data, and mitigate financial and reputational
+ damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ published_at: '2024-02-14T12:29:18Z'
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ alert_stats:
+ open_count: 10
+ closed_count: 3
+ in_progress_count: 3
code-scanning-organization-alert-items:
value:
- number: 4
diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
index 3ded5679d..b76ea3869 100644
--- a/descriptions/api.github.com/api.github.com.json
+++ b/descriptions/api.github.com/api.github.com.json
@@ -179,6 +179,10 @@
{
"name": "hosted-compute",
"description": "Manage hosted compute networking resources."
+ },
+ {
+ "name": "campaigns",
+ "description": "Endpoints to manage campaigns via the REST API."
}
],
"servers": [
@@ -10657,6 +10661,526 @@
}
}
},
+ "/orgs/{org}/campaigns": {
+ "get": {
+ "summary": "List campaigns for an organization",
+ "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/list-org-campaigns",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "$ref": "#/components/parameters/page"
+ },
+ {
+ "$ref": "#/components/parameters/per-page"
+ },
+ {
+ "$ref": "#/components/parameters/direction"
+ },
+ {
+ "name": "state",
+ "description": "If specified, only campaigns with this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/campaign-state"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "ends_at",
+ "published"
+ ],
+ "default": "created"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/campaign-summary"
+ }
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-org-items"
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "$ref": "#/components/headers/link"
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "post": {
+ "summary": "Create a campaign for an organization",
+ "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/create-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The login of each manager",
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign. The date must be in the future.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "code_scanning_alerts": {
+ "description": "The code scanning alerts to include in this campaign",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "repository_id": {
+ "type": "integer",
+ "description": "The repository id"
+ },
+ "alert_numbers": {
+ "type": "array",
+ "description": "The alert numbers",
+ "minItems": 1,
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "repository_id",
+ "alert_numbers"
+ ]
+ }
+ },
+ "generate_issues": {
+ "description": "If true, will automatically generate issues for the campaign. The default is false.",
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "ends_at",
+ "code_scanning_alerts"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ "octocat"
+ ],
+ "ends_at": "2024-03-14T00:00:00Z",
+ "code_scanning_alerts": [
+ {
+ "repository_id": 1296269,
+ "alert_numbers": [
+ 1,
+ 2
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/campaign-summary"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-summary"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too Many Requests"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
+ "/orgs/{org}/campaigns/{campaign_number}": {
+ "get": {
+ "summary": "Get a campaign for an organization",
+ "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/get-campaign-summary",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/campaign-summary"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-summary"
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "patch": {
+ "summary": "Update a campaign",
+ "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/update-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "state": {
+ "$ref": "#/components/schemas/campaign-state"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/campaign-summary"
+ },
+ "examples": {
+ "default": {
+ "$ref": "#/components/examples/campaign-summary"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/basic-error"
+ }
+ }
+ }
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "delete": {
+ "summary": "Delete a campaign for an organization",
+ "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/delete-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/org"
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Deletion successful"
+ },
+ "404": {
+ "$ref": "#/components/responses/not_found"
+ },
+ "503": {
+ "$ref": "#/components/responses/service_unavailable"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
"/orgs/{org}/code-scanning/alerts": {
"get": {
"summary": "List code scanning alerts for an organization",
@@ -102880,6 +103404,291 @@
"visibility"
]
},
+ "campaign-state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "nullable-team-simple": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ },
+ "team": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/nullable-team-simple"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ },
+ "campaign-summary": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/simple-user"
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/team"
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "$ref": "#/components/schemas/campaign-state"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
"code-scanning-analysis-tool-name": {
"type": "string",
"description": "The name of the tool used to generate the code scanning analysis."
@@ -103754,181 +104563,6 @@
],
"nullable": true
},
- "nullable-team-simple": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug"
- ],
- "nullable": true
- },
- "team": {
- "title": "Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "node_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "slug": {
- "type": "string"
- },
- "description": {
- "type": "string",
- "nullable": true
- },
- "privacy": {
- "type": "string"
- },
- "notification_setting": {
- "type": "string"
- },
- "permission": {
- "type": "string"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "pull",
- "triage",
- "push",
- "maintain",
- "admin"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "members_url": {
- "type": "string"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri"
- },
- "parent": {
- "$ref": "#/components/schemas/nullable-team-simple"
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "parent"
- ]
- },
"enterprise-team": {
"title": "Enterprise Team",
"description": "Group of enterprise owners and/or members",
@@ -108299,7 +108933,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -119338,6 +119972,12 @@
"type": "array",
"items": {
"type": "object",
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha"
+ ],
"properties": {
"path": {
"type": "string",
@@ -119372,42 +120012,13 @@
"type": "blob",
"size": 30,
"sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "path",
- "mode",
- "type",
- "sha",
- "url",
- "size"
- ]
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
}
]
}
},
"required": [
"sha",
- "url",
"tree",
"truncated"
]
@@ -273652,6 +274263,114 @@
}
]
},
+ "campaign-org-items": {
+ "value": [
+ {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ },
+ {
+ "number": 4,
+ "created_at": "2024-03-30T12:29:18Z",
+ "updated_at": "2024-03-30T12:29:18Z",
+ "name": "Mitre top 10 KEV",
+ "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-04-30T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ }
+ ]
+ },
+ "campaign-summary": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ },
"code-scanning-organization-alert-items": {
"value": [
{
diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
index 3a08d9a6e..0be3e65de 100644
--- a/descriptions/api.github.com/api.github.com.yaml
+++ b/descriptions/api.github.com/api.github.com.yaml
@@ -95,6 +95,8 @@ tags:
description: Manage private registry configurations.
- name: hosted-compute
description: Manage hosted compute networking resources.
+- name: campaigns
+ description: Endpoints to manage campaigns via the REST API.
servers:
- url: https://api.github.com
externalDocs:
@@ -7716,6 +7718,391 @@ paths:
enabledForGitHubApps: true
category: orgs
subcategory: blocking
+ "/orgs/{org}/campaigns":
+ get:
+ summary: List campaigns for an organization
+ description: |-
+ Lists campaigns in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/list-org-campaigns
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ - "$ref": "#/components/parameters/direction"
+ - name: state
+ description: If specified, only campaigns with this state will be returned.
+ in: query
+ required: false
+ schema:
+ "$ref": "#/components/schemas/campaign-state"
+ - name: sort
+ description: The property by which to sort the results.
+ in: query
+ required: false
+ schema:
+ type: string
+ enum:
+ - created
+ - updated
+ - ends_at
+ - published
+ default: created
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-org-items"
+ headers:
+ Link:
+ "$ref": "#/components/headers/link"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ post:
+ summary: Create a campaign for an organization
+ description: |-
+ Create a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+
+ Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
+ in the campaign.
+ tags:
+ - campaigns
+ operationId: campaigns/create-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ description: The login of each manager
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign. The date must
+ be in the future.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ code_scanning_alerts:
+ description: The code scanning alerts to include in this campaign
+ type: array
+ minItems: 1
+ items:
+ type: object
+ additionalProperties: false
+ properties:
+ repository_id:
+ type: integer
+ description: The repository id
+ alert_numbers:
+ type: array
+ description: The alert numbers
+ minItems: 1
+ items:
+ type: integer
+ required:
+ - repository_id
+ - alert_numbers
+ generate_issues:
+ description: If true, will automatically generate issues for the
+ campaign. The default is false.
+ type: boolean
+ default: false
+ required:
+ - name
+ - description
+ - ends_at
+ - code_scanning_alerts
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ description: Address critical alerts before they are exploited to
+ prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - octocat
+ ends_at: '2024-03-14T00:00:00Z'
+ code_scanning_alerts:
+ - repository_id: 1296269
+ alert_numbers:
+ - 1
+ - 2
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-summary"
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '429':
+ description: Too Many Requests
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ "/orgs/{org}/campaigns/{campaign_number}":
+ get:
+ summary: Get a campaign for an organization
+ description: |-
+ Gets a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/get-campaign-summary
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-summary"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ patch:
+ summary: Update a campaign
+ description: |-
+ Updates a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/update-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign, in ISO 8601
+ format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ state:
+ "$ref": "#/components/schemas/campaign-state"
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/campaign-summary"
+ examples:
+ default:
+ "$ref": "#/components/examples/campaign-summary"
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/basic-error"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ delete:
+ summary: Delete a campaign for an organization
+ description: |-
+ Deletes a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/delete-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '204':
+ description: Deletion successful
+ '404':
+ "$ref": "#/components/responses/not_found"
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
"/orgs/{org}/code-scanning/alerts":
get:
summary: List code scanning alerts for an organization
@@ -75075,6 +75462,233 @@ components:
- created_at
- updated_at
- visibility
+ campaign-state:
+ title: Campaign state
+ description: Indicates whether a campaign is open or closed
+ type: string
+ enum:
+ - open
+ - closed
+ nullable-team-simple:
+ title: Team Simple
+ description: Groups of organization members that gives permissions on specified
+ repositories.
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the team
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDQ6VGVhbTE=
+ url:
+ description: URL for the team
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1
+ members_url:
+ type: string
+ example: https://api.github.com/organizations/1/team/1/members{/member}
+ name:
+ description: Name of the team
+ type: string
+ example: Justice League
+ description:
+ description: Description of the team
+ type: string
+ nullable: true
+ example: A great team.
+ permission:
+ description: Permission that the team will have for its repositories
+ type: string
+ example: admin
+ privacy:
+ description: The level of privacy this team should have
+ type: string
+ example: closed
+ notification_setting:
+ description: The notification setting the team has set
+ type: string
+ example: notifications_enabled
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ repositories_url:
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1/repos
+ slug:
+ type: string
+ example: justice-league
+ ldap_dn:
+ description: Distinguished Name (DN) that team maps to within LDAP environment
+ example: uid=example,ou=users,dc=github,dc=com
+ type: string
+ required:
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ nullable: true
+ team:
+ title: Team
+ description: Groups of organization members that gives permissions on specified
+ repositories.
+ type: object
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ slug:
+ type: string
+ description:
+ type: string
+ nullable: true
+ privacy:
+ type: string
+ notification_setting:
+ type: string
+ permission:
+ type: string
+ permissions:
+ type: object
+ properties:
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ admin:
+ type: boolean
+ required:
+ - pull
+ - triage
+ - push
+ - maintain
+ - admin
+ url:
+ type: string
+ format: uri
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ members_url:
+ type: string
+ repositories_url:
+ type: string
+ format: uri
+ parent:
+ "$ref": "#/components/schemas/nullable-team-simple"
+ required:
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ - parent
+ campaign-summary:
+ title: Campaign summary
+ description: The campaign metadata and alert stats.
+ type: object
+ properties:
+ number:
+ type: integer
+ description: The number of the newly created campaign
+ created_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was created, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ.
+ updated_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was last updated, in ISO 8601
+ format':' YYYY-MM-DDTHH:MM:SSZ.
+ name:
+ type: string
+ description: The campaign name
+ description:
+ type: string
+ description: The campaign description
+ managers:
+ description: The campaign managers
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-user"
+ team_managers:
+ description: The campaign team managers
+ type: array
+ items:
+ "$ref": "#/components/schemas/team"
+ published_at:
+ description: The date and time the campaign was published, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ ends_at:
+ description: The date and time the campaign has ended, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ closed_at:
+ description: The date and time the campaign was closed, in ISO 8601 format':'
+ YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.
+ type: string
+ format: date-time
+ nullable: true
+ state:
+ "$ref": "#/components/schemas/campaign-state"
+ contact_link:
+ description: The contact link of the campaign.
+ type: string
+ format: uri
+ nullable: true
+ alert_stats:
+ type: object
+ additionalProperties: false
+ properties:
+ open_count:
+ type: integer
+ description: The number of open alerts
+ closed_count:
+ type: integer
+ description: The number of closed alerts
+ in_progress_count:
+ type: integer
+ description: The number of in-progress alerts
+ required:
+ - open_count
+ - closed_count
+ - in_progress_count
+ required:
+ - number
+ - created_at
+ - updated_at
+ - description
+ - managers
+ - ends_at
+ - state
+ - contact_link
code-scanning-analysis-tool-name:
type: string
description: The name of the tool used to generate the code scanning analysis.
@@ -75801,143 +76415,6 @@ components:
- avatar_url
- description
nullable: true
- nullable-team-simple:
- title: Team Simple
- description: Groups of organization members that gives permissions on specified
- repositories.
- type: object
- properties:
- id:
- description: Unique identifier of the team
- type: integer
- example: 1
- node_id:
- type: string
- example: MDQ6VGVhbTE=
- url:
- description: URL for the team
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1
- members_url:
- type: string
- example: https://api.github.com/organizations/1/team/1/members{/member}
- name:
- description: Name of the team
- type: string
- example: Justice League
- description:
- description: Description of the team
- type: string
- nullable: true
- example: A great team.
- permission:
- description: Permission that the team will have for its repositories
- type: string
- example: admin
- privacy:
- description: The level of privacy this team should have
- type: string
- example: closed
- notification_setting:
- description: The notification setting the team has set
- type: string
- example: notifications_enabled
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- repositories_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1/repos
- slug:
- type: string
- example: justice-league
- ldap_dn:
- description: Distinguished Name (DN) that team maps to within LDAP environment
- example: uid=example,ou=users,dc=github,dc=com
- type: string
- required:
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- nullable: true
- team:
- title: Team
- description: Groups of organization members that gives permissions on specified
- repositories.
- type: object
- properties:
- id:
- type: integer
- node_id:
- type: string
- name:
- type: string
- slug:
- type: string
- description:
- type: string
- nullable: true
- privacy:
- type: string
- notification_setting:
- type: string
- permission:
- type: string
- permissions:
- type: object
- properties:
- pull:
- type: boolean
- triage:
- type: boolean
- push:
- type: boolean
- maintain:
- type: boolean
- admin:
- type: boolean
- required:
- - pull
- - triage
- - push
- - maintain
- - admin
- url:
- type: string
- format: uri
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- members_url:
- type: string
- repositories_url:
- type: string
- format: uri
- parent:
- "$ref": "#/components/schemas/nullable-team-simple"
- required:
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- - parent
enterprise-team:
title: Enterprise Team
description: Group of enterprise owners and/or members
@@ -79466,11 +79943,8 @@ components:
- rebase
automatic_copilot_code_review_enabled:
type: boolean
- description: |-
- > [!NOTE]
- > `automatic_copilot_code_review_enabled` is in beta and subject to change.
-
- Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.
+ description: Automatically request review from Copilot for new pull
+ requests, if the author has access to Copilot code review.
dismiss_stale_reviews_on_push:
type: boolean
description: New, reviewable commits pushed will dismiss previous pull
@@ -88012,6 +88486,11 @@ components:
type: array
items:
type: object
+ required:
+ - path
+ - mode
+ - type
+ - sha
properties:
path:
type: string
@@ -88038,29 +88517,8 @@ components:
size: 30
sha: 44b4fc6d56897b048c772eb4087f854f46256132
url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132
- properties:
- path:
- type: string
- mode:
- type: string
- type:
- type: string
- size:
- type: integer
- sha:
- type: string
- url:
- type: string
- required:
- - path
- - mode
- - type
- - sha
- - url
- - size
required:
- sha
- - url
- tree
- truncated
hook-response:
@@ -205306,6 +205764,103 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
+ campaign-org-items:
+ value:
+ - number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited to prevent
+ breaches, protect sensitive data, and mitigate financial and reputational
+ damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ - number: 4
+ created_at: '2024-03-30T12:29:18Z'
+ updated_at: '2024-03-30T12:29:18Z'
+ name: Mitre top 10 KEV
+ description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities)
+ to enhance security by addressing vulnerabilities actively exploited by
+ attackers. This reduces risk, prevents breaches and can help protect sensitive
+ data.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-04-30T12:29:18Z'
+ closed_at:
+ state: open
+ campaign-summary:
+ value:
+ number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited to prevent
+ breaches, protect sensitive data, and mitigate financial and reputational
+ damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ published_at: '2024-02-14T12:29:18Z'
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ alert_stats:
+ open_count: 10
+ closed_count: 3
+ in_progress_count: 3
code-scanning-organization-alert-items:
value:
- number: 4
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 1c7ab9a91..f14ec9647 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
@@ -179,6 +179,10 @@
{
"name": "hosted-compute",
"description": "Manage hosted compute networking resources."
+ },
+ {
+ "name": "campaigns",
+ "description": "Endpoints to manage campaigns via the REST API."
}
],
"servers": [
@@ -65118,6 +65122,2631 @@
}
}
},
+ "/orgs/{org}/campaigns": {
+ "get": {
+ "summary": "List campaigns for an organization",
+ "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/list-org-campaigns",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The direction to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "state",
+ "description": "If specified, only campaigns with this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "ends_at",
+ "published"
+ ],
+ "default": "created"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ },
+ {
+ "number": 4,
+ "created_at": "2024-03-30T12:29:18Z",
+ "updated_at": "2024-03-30T12:29:18Z",
+ "name": "Mitre top 10 KEV",
+ "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-04-30T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "post": {
+ "summary": "Create a campaign for an organization",
+ "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/create-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The login of each manager",
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign. The date must be in the future.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "code_scanning_alerts": {
+ "description": "The code scanning alerts to include in this campaign",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "repository_id": {
+ "type": "integer",
+ "description": "The repository id"
+ },
+ "alert_numbers": {
+ "type": "array",
+ "description": "The alert numbers",
+ "minItems": 1,
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "repository_id",
+ "alert_numbers"
+ ]
+ }
+ },
+ "generate_issues": {
+ "description": "If true, will automatically generate issues for the campaign. The default is false.",
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "ends_at",
+ "code_scanning_alerts"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ "octocat"
+ ],
+ "ends_at": "2024-03-14T00:00:00Z",
+ "code_scanning_alerts": [
+ {
+ "repository_id": 1296269,
+ "alert_numbers": [
+ 1,
+ 2
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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": "Unprocessable Entity",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too Many Requests"
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
+ "/orgs/{org}/campaigns/{campaign_number}": {
+ "get": {
+ "summary": "Get a campaign for an organization",
+ "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/get-campaign-summary",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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": "Unprocessable Entity",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "patch": {
+ "summary": "Update a campaign",
+ "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/update-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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": "Unprocessable Entity",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "delete": {
+ "summary": "Delete a campaign for an organization",
+ "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/delete-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Deletion successful"
+ },
+ "404": {
+ "description": "Resource not found",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
"/orgs/{org}/code-scanning/alerts": {
"get": {
"summary": "List code scanning alerts for an organization",
@@ -124402,7 +127031,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -125684,7 +128313,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -126973,7 +129602,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -128903,7 +131532,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -130210,7 +132839,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -131495,7 +134124,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -281292,6 +283921,12 @@
"type": "array",
"items": {
"type": "object",
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha"
+ ],
"properties": {
"path": {
"type": "string",
@@ -281326,42 +283961,13 @@
"type": "blob",
"size": 30,
"sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "path",
- "mode",
- "type",
- "sha",
- "url",
- "size"
- ]
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
}
]
}
},
"required": [
"sha",
- "url",
"tree",
"truncated"
]
@@ -281628,6 +284234,12 @@
"type": "array",
"items": {
"type": "object",
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha"
+ ],
"properties": {
"path": {
"type": "string",
@@ -281662,42 +284274,13 @@
"type": "blob",
"size": 30,
"sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "path",
- "mode",
- "type",
- "sha",
- "url",
- "size"
- ]
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
}
]
}
},
"required": [
"sha",
- "url",
"tree",
"truncated"
]
@@ -407009,7 +409592,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -408721,7 +411304,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -409793,7 +412376,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -411072,7 +413655,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -413021,7 +415604,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -414108,7 +416691,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -415383,7 +417966,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1050924,7 +1053507,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1053773,7 +1056356,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1056622,7 +1059205,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1057622,7 +1060205,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1058450,7 +1061033,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1059281,7 +1061864,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
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 5403169d0..4abf0ec91 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
@@ -95,6 +95,8 @@ tags:
description: Manage private registry configurations.
- name: hosted-compute
description: Manage hosted compute networking resources.
+- name: campaigns
+ description: Endpoints to manage campaigns via the REST API.
servers:
- url: https://api.github.com
externalDocs:
@@ -847,7 +849,7 @@ paths:
- subscriptions_url
- type
- url
- type: &253
+ type: &256
type: string
description: The type of credit the user is receiving.
enum:
@@ -1013,7 +1015,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &581
+ - &584
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1576,7 +1578,7 @@ paths:
schema:
type: integer
default: 30
- - &166
+ - &170
name: cursor
description: 'Used for pagination: the starting delivery from which the page
of deliveries is fetched. Refer to the `link` header for the next and previous
@@ -1592,7 +1594,7 @@ paths:
application/json:
schema:
type: array
- items: &167
+ items: &171
title: Simple webhook delivery
description: Delivery made by a webhook, without request and response
information.
@@ -1672,7 +1674,7 @@ paths:
- installation_id
- repository_id
examples:
- default: &168
+ default: &172
value:
- id: 12345678
guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516
@@ -1800,7 +1802,7 @@ paths:
description: Response
content:
application/json:
- schema: &169
+ schema: &173
title: Webhook delivery
description: Delivery made by a webhook.
type: object
@@ -1914,7 +1916,7 @@ paths:
- request
- response
examples:
- default: &170
+ default: &174
value:
id: 12345678
guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516
@@ -2841,7 +2843,7 @@ paths:
title: Repository
description: A repository on GitHub.
type: object
- properties: &232
+ properties: &235
id:
description: Unique identifier of the repository
example: 42
@@ -3270,7 +3272,7 @@ paths:
type: boolean
description: Whether anonymous git access is enabled for
this repository
- required: &233
+ required: &236
- archive_url
- assignees_url
- blobs_url
@@ -7476,7 +7478,7 @@ paths:
description: Response
content:
application/json:
- schema: &140
+ schema: &143
type: array
description: A list of default code security configurations
items:
@@ -7492,7 +7494,7 @@ paths:
default
configuration: *42
examples:
- default: &141
+ default: &144
value:
- default_for_new_repos: public
configuration:
@@ -7800,7 +7802,7 @@ paths:
- *41
- *44
responses:
- '204': &142
+ '204': &145
description: A header with no content is returned.
'400': *14
'403': *29
@@ -7927,7 +7929,7 @@ paths:
default:
value:
default_for_new_repos: all
- configuration: &139
+ configuration: &142
value:
id: 1325
target_type: organization
@@ -8010,7 +8012,7 @@ paths:
application/json:
schema:
type: array
- items: &143
+ items: &146
type: object
description: Repositories associated with a code security configuration
and attachment status
@@ -8311,7 +8313,7 @@ paths:
summary: Example of code security configuration repositories
value:
- status: attached
- repository: &144
+ repository: &147
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -8405,7 +8407,7 @@ paths:
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise
parameters:
- *41
- - &149
+ - &153
name: state
in: query
description: |-
@@ -8414,7 +8416,7 @@ paths:
Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
schema:
type: string
- - &150
+ - &154
name: severity
in: query
description: |-
@@ -8423,7 +8425,7 @@ paths:
Can be: `low`, `medium`, `high`, `critical`
schema:
type: string
- - &151
+ - &155
name: ecosystem
in: query
description: |-
@@ -8432,14 +8434,14 @@ paths:
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
schema:
type: string
- - &152
+ - &156
name: package
in: query
description: A comma-separated list of package names. If specified, only alerts
for these packages will be returned.
schema:
type: string
- - &153
+ - &157
name: epss_percentage
in: query
description: |-
@@ -8451,7 +8453,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
- - &154
+ - &158
name: scope
in: query
description: The scope of the vulnerable dependency. If specified, only alerts
@@ -8461,7 +8463,7 @@ paths:
enum:
- development
- runtime
- - &155
+ - &159
name: sort
in: query
description: |-
@@ -8479,7 +8481,7 @@ paths:
- *48
- *39
- *40
- - &156
+ - &160
name: first
description: |-
**Deprecated**. The number of results per page (max 100), starting from the first matching result.
@@ -8492,7 +8494,7 @@ paths:
minimum: 1
maximum: 100
default: 30
- - &157
+ - &161
name: last
description: |-
**Deprecated**. The number of results per page (max 100), starting from the last matching result.
@@ -8512,7 +8514,7 @@ paths:
application/json:
schema:
type: array
- items: &158
+ items: &162
type: object
description: A Dependabot alert.
properties:
@@ -8578,7 +8580,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &426
+ security_advisory: &429
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -8797,13 +8799,13 @@ paths:
format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- updated_at: &133
+ updated_at: &136
type: string
description: 'The time that the alert was last updated in ISO
8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissed_at: &135
+ dismissed_at: &138
type: string
description: 'The time that the alert was dismissed in ISO 8601
format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -8833,14 +8835,14 @@ paths:
dismissal.
nullable: true
maxLength: 280
- fixed_at: &134
+ fixed_at: &137
type: string
description: 'The time that the alert was no longer detected
and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- auto_dismissed_at: &427
+ auto_dismissed_at: &430
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -8866,7 +8868,7 @@ paths:
- repository
additionalProperties: false
examples:
- default: &159
+ default: &163
value:
- number: 2
state: dismissed
@@ -9213,7 +9215,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
parameters:
- *41
- - &244
+ - &247
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -9224,7 +9226,7 @@ paths:
enum:
- open
- resolved
- - &245
+ - &248
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -9234,7 +9236,7 @@ paths:
required: false
schema:
type: string
- - &246
+ - &249
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -9243,7 +9245,7 @@ paths:
required: false
schema:
type: string
- - &247
+ - &250
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.
@@ -9259,7 +9261,7 @@ paths:
- *17
- *39
- *40
- - &248
+ - &251
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -9268,7 +9270,7 @@ paths:
required: false
schema:
type: string
- - &249
+ - &252
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -9277,7 +9279,7 @@ paths:
schema:
type: boolean
default: false
- - &250
+ - &253
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -9293,7 +9295,7 @@ paths:
application/json:
schema:
type: array
- items: &251
+ items: &254
type: object
properties:
number: *54
@@ -9312,14 +9314,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &573
+ state: &576
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: &574
+ resolution: &577
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -9421,7 +9423,7 @@ paths:
is base64 encoded
nullable: true
examples:
- default: &252
+ default: &255
value:
- number: 2
created_at: '2020-11-06T18:48:51Z'
@@ -9757,7 +9759,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &475
+ properties: &478
id:
type: integer
format: int64
@@ -9868,7 +9870,7 @@ paths:
description: A collection of related issues and pull
requests.
type: object
- properties: &411
+ properties: &414
url:
type: string
format: uri
@@ -9938,7 +9940,7 @@ paths:
format: date-time
example: '2012-10-09T23:39:01Z'
nullable: true
- required: &412
+ required: &415
- closed_issues
- creator
- description
@@ -10017,7 +10019,7 @@ paths:
timeline_url:
type: string
format: uri
- type: &189
+ type: &192
title: Issue Type
description: The type of issue.
type: object
@@ -10142,7 +10144,7 @@ paths:
- total
- completed
- percent_completed
- required: &476
+ required: &479
- assignee
- closed_at
- comments
@@ -10164,7 +10166,7 @@ paths:
- author_association
- created_at
- updated_at
- comment: &473
+ comment: &476
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -10731,7 +10733,7 @@ paths:
url:
type: string
format: uri
- user: &604
+ user: &607
title: Public User
description: Public User
type: object
@@ -12601,7 +12603,7 @@ paths:
- closed
- all
default: open
- - &192
+ - &195
name: labels
description: 'A list of comma separated label names. Example: `bug,ui,@high`'
in: query
@@ -12652,7 +12654,7 @@ paths:
type: array
items: *77
examples:
- default: &193
+ default: &196
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -14036,14 +14038,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &276
+ - &279
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &277
+ - &280
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -14114,7 +14116,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &288
+ '301': &291
description: Moved permanently
content:
application/json:
@@ -14136,7 +14138,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &505
+ - &508
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -14144,7 +14146,7 @@ paths:
schema:
type: boolean
default: false
- - &506
+ - &509
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -14154,7 +14156,7 @@ paths:
type: boolean
default: false
- *67
- - &507
+ - &510
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:
@@ -14190,7 +14192,7 @@ paths:
title: Minimal Repository
description: Minimal Repository
type: object
- properties: &161
+ properties: &165
id:
type: integer
format: int64
@@ -14466,7 +14468,7 @@ paths:
web_commit_signoff_required:
type: boolean
example: false
- security_and_analysis: &234
+ security_and_analysis: &237
nullable: true
type: object
properties:
@@ -14530,7 +14532,7 @@ paths:
enum:
- enabled
- disabled
- required: &162
+ required: &166
- archive_url
- assignees_url
- blobs_url
@@ -14618,7 +14620,7 @@ paths:
- url
- subscription_url
examples:
- default: &508
+ default: &511
value:
- id: '1'
repository:
@@ -15160,11 +15162,11 @@ paths:
application/json:
schema:
type: array
- items: &199
+ items: &202
title: Organization Simple
description: A GitHub organization.
type: object
- properties: &147
+ properties: &150
login:
type: string
example: github
@@ -15205,7 +15207,7 @@ paths:
type: string
example: A great organization
nullable: true
- required: &148
+ required: &151
- login
- url
- id
@@ -15219,7 +15221,7 @@ paths:
- avatar_url
- description
examples:
- default: &622
+ default: &625
value:
- login: github
id: 1
@@ -15371,7 +15373,7 @@ paths:
repositoryName: github/example
'400': *14
'403': *29
- '500': &145
+ '500': &148
description: Internal Error
content:
application/json:
@@ -16128,7 +16130,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &293
+ items: &296
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -16996,7 +16998,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &299
+ selected_actions_url: &302
type: string
description: The API URL to use to get or set the actions and
reusable workflows that are allowed to run, when `allowed_actions`
@@ -17086,7 +17088,7 @@ paths:
type: array
items: *60
examples:
- default: &616
+ default: &619
value:
total_count: 1
repositories:
@@ -17414,7 +17416,7 @@ paths:
description: Response
content:
application/json:
- schema: &303
+ schema: &306
type: object
properties:
default_workflow_permissions: &112
@@ -17465,7 +17467,7 @@ paths:
required: false
content:
application/json:
- schema: &304
+ schema: &307
type: object
properties:
default_workflow_permissions: *112
@@ -17954,7 +17956,7 @@ paths:
type: array
items: *119
examples:
- default: &607
+ default: &610
value:
total_count: 1
repositories:
@@ -18596,7 +18598,7 @@ paths:
application/json:
schema:
type: array
- items: &305
+ items: &308
title: Runner Application
description: Runner Application
type: object
@@ -18621,7 +18623,7 @@ paths:
- download_url
- filename
examples:
- default: &306
+ default: &309
value:
- os: osx
architecture: x64
@@ -18707,7 +18709,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &307
+ '201': &310
description: Response
content:
application/json:
@@ -18818,7 +18820,7 @@ paths:
- token
- expires_at
examples:
- default: &308
+ default: &311
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -18857,7 +18859,7 @@ paths:
application/json:
schema: *123
examples:
- default: &309
+ default: &312
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -18891,7 +18893,7 @@ paths:
application/json:
schema: *121
examples:
- default: &310
+ default: &313
value:
id: 23
name: MBP
@@ -19116,7 +19118,7 @@ paths:
- *94
- *120
responses:
- '200': &311
+ '200': &314
description: Response
content:
application/json:
@@ -19173,7 +19175,7 @@ paths:
parameters:
- *94
- *120
- - &312
+ - &315
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -19303,7 +19305,7 @@ paths:
description: Response
content:
application/json:
- schema: &324
+ schema: &327
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -19332,7 +19334,7 @@ paths:
- key_id
- key
examples:
- default: &325
+ default: &328
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -19745,7 +19747,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *94
- - &298
+ - &301
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/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -20280,7 +20282,7 @@ paths:
bundle_url:
type: string
examples:
- default: &338
+ default: &341
value:
attestations:
- bundle:
@@ -20399,7 +20401,7 @@ paths:
type: array
items: *4
examples:
- default: &194
+ default: &197
value:
- login: octocat
id: 1
@@ -20500,6 +20502,684 @@ paths:
enabledForGitHubApps: true
category: orgs
subcategory: blocking
+ "/orgs/{org}/campaigns":
+ get:
+ summary: List campaigns for an organization
+ description: |-
+ Lists campaigns in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/list-org-campaigns
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization
+ parameters:
+ - *94
+ - *19
+ - *17
+ - *48
+ - name: state
+ description: If specified, only campaigns with this state will be returned.
+ in: query
+ required: false
+ schema: &133
+ title: Campaign state
+ description: Indicates whether a campaign is open or closed
+ type: string
+ enum:
+ - open
+ - closed
+ - name: sort
+ description: The property by which to sort the results.
+ in: query
+ required: false
+ schema:
+ type: string
+ enum:
+ - created
+ - updated
+ - ends_at
+ - published
+ default: created
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items: &134
+ title: Campaign summary
+ description: The campaign metadata and alert stats.
+ type: object
+ properties:
+ number:
+ type: integer
+ description: The number of the newly created campaign
+ created_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was created, in
+ ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ updated_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was last updated,
+ in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ name:
+ type: string
+ description: The campaign name
+ description:
+ type: string
+ description: The campaign description
+ managers:
+ description: The campaign managers
+ type: array
+ items: *4
+ team_managers:
+ description: The campaign team managers
+ type: array
+ items: &152
+ title: Team
+ description: Groups of organization members that gives permissions
+ on specified repositories.
+ type: object
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ slug:
+ type: string
+ description:
+ type: string
+ nullable: true
+ privacy:
+ type: string
+ notification_setting:
+ type: string
+ permission:
+ type: string
+ permissions:
+ type: object
+ properties:
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ admin:
+ type: boolean
+ required:
+ - pull
+ - triage
+ - push
+ - maintain
+ - admin
+ url:
+ type: string
+ format: uri
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ members_url:
+ type: string
+ repositories_url:
+ type: string
+ format: uri
+ parent:
+ title: Team Simple
+ description: Groups of organization members that gives
+ permissions on specified repositories.
+ type: object
+ properties: &210
+ id:
+ description: Unique identifier of the team
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDQ6VGVhbTE=
+ url:
+ description: URL for the team
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1
+ members_url:
+ type: string
+ example: https://api.github.com/organizations/1/team/1/members{/member}
+ name:
+ description: Name of the team
+ type: string
+ example: Justice League
+ description:
+ description: Description of the team
+ type: string
+ nullable: true
+ example: A great team.
+ permission:
+ description: Permission that the team will have for
+ its repositories
+ type: string
+ example: admin
+ privacy:
+ description: The level of privacy this team should
+ have
+ type: string
+ example: closed
+ notification_setting:
+ description: The notification setting the team has
+ set
+ type: string
+ example: notifications_enabled
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ repositories_url:
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1/repos
+ slug:
+ type: string
+ example: justice-league
+ ldap_dn:
+ description: Distinguished Name (DN) that team maps
+ to within LDAP environment
+ example: uid=example,ou=users,dc=github,dc=com
+ type: string
+ required: &211
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ nullable: true
+ required:
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ - parent
+ published_at:
+ description: The date and time the campaign was published, in
+ ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ ends_at:
+ description: The date and time the campaign has ended, in ISO
+ 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ closed_at:
+ description: The date and time the campaign was closed, in ISO
+ 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign
+ is still open.
+ type: string
+ format: date-time
+ nullable: true
+ state: *133
+ contact_link:
+ description: The contact link of the campaign.
+ type: string
+ format: uri
+ nullable: true
+ alert_stats:
+ type: object
+ additionalProperties: false
+ properties:
+ open_count:
+ type: integer
+ description: The number of open alerts
+ closed_count:
+ type: integer
+ description: The number of closed alerts
+ in_progress_count:
+ type: integer
+ description: The number of in-progress alerts
+ required:
+ - open_count
+ - closed_count
+ - in_progress_count
+ required:
+ - number
+ - created_at
+ - updated_at
+ - description
+ - managers
+ - ends_at
+ - state
+ - contact_link
+ examples:
+ default:
+ value:
+ - number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited
+ to prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ - number: 4
+ created_at: '2024-03-30T12:29:18Z'
+ updated_at: '2024-03-30T12:29:18Z'
+ name: Mitre top 10 KEV
+ description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities)
+ to enhance security by addressing vulnerabilities actively exploited
+ by attackers. This reduces risk, prevents breaches and can help
+ protect sensitive data.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-04-30T12:29:18Z'
+ closed_at:
+ state: open
+ headers:
+ Link: *58
+ '404': *6
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ post:
+ summary: Create a campaign for an organization
+ description: |-
+ Create a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+
+ Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
+ in the campaign.
+ tags:
+ - campaigns
+ operationId: campaigns/create-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization
+ parameters:
+ - *94
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ description: The login of each manager
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign. The date must
+ be in the future.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ code_scanning_alerts:
+ description: The code scanning alerts to include in this campaign
+ type: array
+ minItems: 1
+ items:
+ type: object
+ additionalProperties: false
+ properties:
+ repository_id:
+ type: integer
+ description: The repository id
+ alert_numbers:
+ type: array
+ description: The alert numbers
+ minItems: 1
+ items:
+ type: integer
+ required:
+ - repository_id
+ - alert_numbers
+ generate_issues:
+ description: If true, will automatically generate issues for the
+ campaign. The default is false.
+ type: boolean
+ default: false
+ required:
+ - name
+ - description
+ - ends_at
+ - code_scanning_alerts
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ description: Address critical alerts before they are exploited to
+ prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - octocat
+ ends_at: '2024-03-14T00:00:00Z'
+ code_scanning_alerts:
+ - repository_id: 1296269
+ alert_numbers:
+ - 1
+ - 2
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema: *134
+ examples:
+ default: &135
+ value:
+ number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited
+ to prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ published_at: '2024-02-14T12:29:18Z'
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ alert_stats:
+ open_count: 10
+ closed_count: 3
+ in_progress_count: 3
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema: *3
+ '404': *6
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema: *3
+ '429':
+ description: Too Many Requests
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ "/orgs/{org}/campaigns/{campaign_number}":
+ get:
+ summary: Get a campaign for an organization
+ description: |-
+ Gets a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/get-campaign-summary
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization
+ parameters:
+ - *94
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema: *134
+ examples:
+ default: *135
+ '404': *6
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema: *3
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ patch:
+ summary: Update a campaign
+ description: |-
+ Updates a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/update-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign
+ parameters:
+ - *94
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign, in ISO 8601
+ format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ state: *133
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema: *134
+ examples:
+ default: *135
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema: *3
+ '404': *6
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema: *3
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ delete:
+ summary: Delete a campaign for an organization
+ description: |-
+ Deletes a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/delete-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization
+ parameters:
+ - *94
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '204':
+ description: Deletion successful
+ '404': *6
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
"/orgs/{org}/code-scanning/alerts":
get:
summary: List code scanning alerts for an organization
@@ -20517,17 +21197,17 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *94
- - &364
+ - &367
name: tool_name
description: The name of a code scanning tool. Only results by this tool will
be listed. You can specify the tool by using either `tool_name` or `tool_guid`,
but not both.
in: query
required: false
- schema: &136
+ schema: &139
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &365
+ - &368
name: tool_guid
description: The GUID of a code scanning tool. Only results by this tool will
be listed. Note that some code scanning tools may not include a GUID in
@@ -20535,7 +21215,7 @@ paths:
or `tool_name`, but not both.
in: query
required: false
- schema: &137
+ schema: &140
nullable: true
type: string
description: The GUID of the tool used to generate the code scanning analysis,
@@ -20550,7 +21230,7 @@ paths:
be returned.
in: query
required: false
- schema: &367
+ schema: &370
type: string
description: State of a code scanning alert.
enum:
@@ -20573,7 +21253,7 @@ paths:
be returned.
in: query
required: false
- schema: &368
+ schema: &371
type: string
description: Severity of a code scanning alert.
enum:
@@ -20596,16 +21276,16 @@ paths:
properties:
number: *54
created_at: *55
- updated_at: *133
+ updated_at: *136
url: *56
html_url: *57
- instances_url: &369
+ instances_url: &372
type: string
description: The REST API URL for fetching the list of instances
for an alert.
format: uri
readOnly: true
- state: &138
+ state: &141
type: string
description: State of a code scanning alert.
nullable: true
@@ -20613,7 +21293,7 @@ paths:
- open
- dismissed
- fixed
- fixed_at: *134
+ fixed_at: *137
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -20621,8 +21301,8 @@ paths:
properties: *20
required: *21
nullable: true
- dismissed_at: *135
- dismissed_reason: &370
+ dismissed_at: *138
+ dismissed_reason: &373
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -20631,13 +21311,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &371
+ dismissed_comment: &374
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &372
+ rule: &375
type: object
properties:
id:
@@ -20690,25 +21370,25 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &373
+ tool: &376
type: object
properties:
- name: *136
+ name: *139
version:
nullable: true
type: string
description: The version of the tool used to generate the
code scanning analysis.
- guid: *137
- most_recent_instance: &374
+ guid: *140
+ most_recent_instance: &377
type: object
properties:
- ref: &366
+ ref: &369
type: string
description: |-
The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,
`refs/heads/<branch name>` or simply `<branch name>`.
- analysis_key: &384
+ analysis_key: &387
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
@@ -20719,13 +21399,13 @@ paths:
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &385
+ category: &388
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
analyses for the same tool and commit, but performed on
different languages or different parts of the code.
- state: *138
+ state: *141
commit_sha:
type: string
message:
@@ -21351,7 +22031,7 @@ paths:
application/json:
schema: *42
examples:
- default: *139
+ default: *142
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -21379,9 +22059,9 @@ paths:
description: Response
content:
application/json:
- schema: *140
+ schema: *143
examples:
- default: *141
+ default: *144
'304': *37
'403': *29
'404': *6
@@ -21430,7 +22110,7 @@ paths:
- 32
- 91
responses:
- '204': *142
+ '204': *145
'400': *14
'403': *29
'404': *6
@@ -21465,7 +22145,7 @@ paths:
application/json:
schema: *42
examples:
- default: *139
+ default: *142
'304': *37
'403': *29
'404': *6
@@ -21727,7 +22407,7 @@ paths:
- *94
- *44
responses:
- '204': *142
+ '204': *145
'400': *14
'403': *29
'404': *6
@@ -21865,7 +22545,7 @@ paths:
default:
value:
default_for_new_repos: all
- configuration: *139
+ configuration: *142
'403': *29
'404': *6
x-github:
@@ -21918,13 +22598,13 @@ paths:
application/json:
schema:
type: array
- items: *143
+ items: *146
examples:
default:
summary: Example of code security configuration repositories
value:
- status: attached
- repository: *144
+ repository: *147
'403': *29
'404': *6
x-github:
@@ -21964,7 +22644,7 @@ paths:
type: integer
codespaces:
type: array
- items: &195
+ items: &198
type: object
title: Codespace
description: A codespace.
@@ -21994,7 +22674,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &397
+ properties: &400
name:
type: string
description: The name of the machine.
@@ -22036,7 +22716,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &398
+ required: &401
- name
- display_name
- operating_system
@@ -22241,7 +22921,7 @@ paths:
- pulls_url
- recent_folders
examples:
- default: &196
+ default: &199
value:
total_count: 3
codespaces:
@@ -22651,7 +23331,7 @@ paths:
stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop
recent_folders: []
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -22717,7 +23397,7 @@ paths:
description: Users are neither members nor collaborators of this organization.
'404': *6
'422': *15
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -22772,7 +23452,7 @@ paths:
description: Users are neither members nor collaborators of this organization.
'404': *6
'422': *15
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -22826,7 +23506,7 @@ paths:
description: Users are neither members nor collaborators of this organization.
'404': *6
'422': *15
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -22865,7 +23545,7 @@ paths:
type: integer
secrets:
type: array
- items: &146
+ items: &149
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -22904,7 +23584,7 @@ paths:
- updated_at
- visibility
examples:
- default: &399
+ default: &402
value:
total_count: 2
secrets:
@@ -22942,7 +23622,7 @@ paths:
description: Response
content:
application/json:
- schema: &400
+ schema: &403
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -22971,7 +23651,7 @@ paths:
- key_id
- key
examples:
- default: &401
+ default: &404
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -23001,9 +23681,9 @@ paths:
description: Response
content:
application/json:
- schema: *146
+ schema: *149
examples:
- default: &403
+ default: &406
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -23415,7 +24095,7 @@ paths:
cli: enabled
public_code_suggestions: block
plan_type: business
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -23470,7 +24150,7 @@ paths:
currently being billed.
seats:
type: array
- items: &198
+ items: &201
title: Copilot Business Seat Detail
description: Information about a Copilot Business seat assignment
for a user, team, or organization.
@@ -23481,152 +24161,14 @@ paths:
title: Organization Simple
description: A GitHub organization.
type: object
- properties: *147
- required: *148
+ properties: *150
+ required: *151
nullable: true
assigning_team:
description: The team through which the assignee is granted
access to GitHub Copilot, if applicable.
oneOf:
- - &188
- title: Team
- description: Groups of organization members that gives
- permissions on specified repositories.
- type: object
- properties:
- id:
- type: integer
- node_id:
- type: string
- name:
- type: string
- slug:
- type: string
- description:
- type: string
- nullable: true
- privacy:
- type: string
- notification_setting:
- type: string
- permission:
- type: string
- permissions:
- type: object
- properties:
- pull:
- type: boolean
- triage:
- type: boolean
- push:
- type: boolean
- maintain:
- type: boolean
- admin:
- type: boolean
- required:
- - pull
- - triage
- - push
- - maintain
- - admin
- url:
- type: string
- format: uri
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- members_url:
- type: string
- repositories_url:
- type: string
- format: uri
- parent:
- title: Team Simple
- description: Groups of organization members that gives
- permissions on specified repositories.
- type: object
- properties: &207
- id:
- description: Unique identifier of the team
- type: integer
- example: 1
- node_id:
- type: string
- example: MDQ6VGVhbTE=
- url:
- description: URL for the team
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1
- members_url:
- type: string
- example: https://api.github.com/organizations/1/team/1/members{/member}
- name:
- description: Name of the team
- type: string
- example: Justice League
- description:
- description: Description of the team
- type: string
- nullable: true
- example: A great team.
- permission:
- description: Permission that the team will have
- for its repositories
- type: string
- example: admin
- privacy:
- description: The level of privacy this team should
- have
- type: string
- example: closed
- notification_setting:
- description: The notification setting the team
- has set
- type: string
- example: notifications_enabled
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- repositories_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1/repos
- slug:
- type: string
- example: justice-league
- ldap_dn:
- description: Distinguished Name (DN) that team
- maps to within LDAP environment
- example: uid=example,ou=users,dc=github,dc=com
- type: string
- required: &208
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- nullable: true
- required:
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- - parent
+ - *152
- title: Enterprise Team
description: Group of enterprise owners and/or members
type: object
@@ -23791,7 +24333,7 @@ paths:
site_admin: false
headers:
Link: *58
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -23866,7 +24408,7 @@ paths:
default:
value:
seats_created: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -23944,7 +24486,7 @@ paths:
default:
value:
seats_cancelled: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -24023,7 +24565,7 @@ paths:
default:
value:
seats_created: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -24101,7 +24643,7 @@ paths:
default:
value:
seats_cancelled: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -24172,7 +24714,7 @@ paths:
application/json:
schema:
type: array
- items: &258
+ items: &261
title: Copilot Usage Metrics
description: Copilot usage metrics for a given day.
type: object
@@ -24479,7 +25021,7 @@ paths:
- date
additionalProperties: true
examples:
- default: &259
+ default: &262
value:
- date: '2024-06-24'
total_active_users: 24
@@ -24578,10 +25120,10 @@ paths:
custom_model_training_date: '2024-02-01'
total_pr_summaries_created: 10
total_engaged_users: 4
- '500': *145
+ '500': *148
'403': *29
'404': *6
- '422': &260
+ '422': &263
description: Copilot Usage Merics API setting is disabled at the organization
or enterprise level.
content:
@@ -24609,18 +25151,18 @@ paths:
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization
parameters:
- *94
- - *149
- - *150
- - *151
- - *152
- *153
- *154
- *155
+ - *156
+ - *157
+ - *158
+ - *159
- *48
- *39
- *40
- - *156
- - *157
+ - *160
+ - *161
- *17
responses:
'200':
@@ -24629,9 +25171,9 @@ paths:
application/json:
schema:
type: array
- items: *158
+ items: *162
examples:
- default: *159
+ default: *163
'304': *37
'400': *14
'403': *29
@@ -24675,7 +25217,7 @@ paths:
type: integer
secrets:
type: array
- items: &160
+ items: &164
title: Dependabot Secret for an Organization
description: Secrets for GitHub Dependabot for an organization.
type: object
@@ -24752,7 +25294,7 @@ paths:
description: Response
content:
application/json:
- schema: &430
+ schema: &433
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -24769,7 +25311,7 @@ paths:
- key_id
- key
examples:
- default: &431
+ default: &434
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -24799,7 +25341,7 @@ paths:
description: Response
content:
application/json:
- schema: *160
+ schema: *164
examples:
default:
value:
@@ -25096,7 +25638,7 @@ paths:
application/json:
schema:
type: array
- items: &210
+ items: &213
title: Package
description: A software package
type: object
@@ -25146,8 +25688,8 @@ paths:
title: Minimal Repository
description: Minimal Repository
type: object
- properties: *161
- required: *162
+ properties: *165
+ required: *166
nullable: true
created_at:
type: string
@@ -25166,7 +25708,7 @@ paths:
- created_at
- updated_at
examples:
- default: &211
+ default: &214
value:
- id: 197
name: hello_docker
@@ -25333,7 +25875,7 @@ paths:
application/json:
schema:
type: array
- items: &185
+ items: &189
title: Organization Invitation
description: Organization Invitation
type: object
@@ -25380,7 +25922,7 @@ paths:
- invitation_teams_url
- node_id
examples:
- default: &186
+ default: &190
value:
- id: 1
login: monalisa
@@ -25447,7 +25989,7 @@ paths:
application/json:
schema:
type: array
- items: &163
+ items: &167
title: Org Hook
description: Org Hook
type: object
@@ -25618,9 +26160,9 @@ paths:
description: Response
content:
application/json:
- schema: *163
+ schema: *167
examples:
- default: &164
+ default: &168
value:
id: 1
url: https://api.github.com/orgs/octocat/hooks/1
@@ -25668,7 +26210,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook
parameters:
- *94
- - &165
+ - &169
name: hook_id
description: The unique identifier of the hook. You can find this value in
the `X-GitHub-Hook-ID` header of a webhook delivery.
@@ -25681,9 +26223,9 @@ paths:
description: Response
content:
application/json:
- schema: *163
+ schema: *167
examples:
- default: *164
+ default: *168
'404': *6
x-github:
githubCloudOnly: false
@@ -25711,7 +26253,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
requestBody:
required: false
content:
@@ -25756,7 +26298,7 @@ paths:
description: Response
content:
application/json:
- schema: *163
+ schema: *167
examples:
default:
value:
@@ -25798,7 +26340,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
responses:
'204':
description: Response
@@ -25826,7 +26368,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization
parameters:
- *94
- - *165
+ - *169
responses:
'200':
description: Response
@@ -25857,7 +26399,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization
parameters:
- *94
- - *165
+ - *169
requestBody:
required: false
content:
@@ -25908,9 +26450,9 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
- *17
- - *166
+ - *170
responses:
'200':
description: Response
@@ -25918,9 +26460,9 @@ paths:
application/json:
schema:
type: array
- items: *167
+ items: *171
examples:
- default: *168
+ default: *172
'400': *14
'422': *15
x-github:
@@ -25946,16 +26488,16 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *169
+ schema: *173
examples:
- default: *170
+ default: *174
'400': *14
'422': *15
x-github:
@@ -25981,7 +26523,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
- *16
responses:
'202': *47
@@ -26011,7 +26553,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
responses:
'204':
description: Response
@@ -26034,7 +26576,7 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor
parameters:
- *94
- - &175
+ - &179
name: actor_type
in: path
description: The type of the actor
@@ -26047,14 +26589,14 @@ paths:
- fine_grained_pat
- oauth_app
- github_app_user_to_server
- - &176
+ - &180
name: actor_id
in: path
description: The ID of the actor
required: true
schema:
type: integer
- - &171
+ - &175
name: min_timestamp
description: 'The minimum timestamp to query for stats. This is a timestamp
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -26062,7 +26604,7 @@ paths:
required: true
schema:
type: string
- - &172
+ - &176
name: max_timestamp
description: 'The maximum timestamp to query for stats. Defaults to the time
30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -26156,12 +26698,12 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats
parameters:
- *94
- - *171
- - *172
+ - *175
+ - *176
- *19
- *17
- *48
- - &181
+ - &185
name: sort
description: The property to sort the results by.
in: query
@@ -26240,14 +26782,14 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats
parameters:
- *94
- - *171
- - *172
+ - *175
+ - *176
responses:
'200':
description: Response
content:
application/json:
- schema: &173
+ schema: &177
title: Summary Stats
description: API Insights usage summary stats for an organization
type: object
@@ -26263,7 +26805,7 @@ paths:
type: integer
format: int64
examples:
- default: &174
+ default: &178
value:
total_request_count: 34225
rate_limited_request_count: 23
@@ -26284,23 +26826,23 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user
parameters:
- *94
- - &177
+ - &181
name: user_id
in: path
description: The ID of the user to query for stats
required: true
schema:
type: string
- - *171
- - *172
+ - *175
+ - *176
responses:
'200':
description: Response
content:
application/json:
- schema: *173
+ schema: *177
examples:
- default: *174
+ default: *178
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26319,18 +26861,18 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor
parameters:
- *94
- - *171
- - *172
- *175
- *176
+ - *179
+ - *180
responses:
'200':
description: Response
content:
application/json:
- schema: *173
+ schema: *177
examples:
- default: *174
+ default: *178
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26348,9 +26890,9 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-time-stats
parameters:
- *94
- - *171
- - *172
- - &178
+ - *175
+ - *176
+ - &182
name: timestamp_increment
description: The increment of time used to breakdown the query results (5m,
10m, 1h, etc.)
@@ -26363,7 +26905,7 @@ paths:
description: Response
content:
application/json:
- schema: &179
+ schema: &183
title: Time Stats
description: API Insights usage time stats for an organization
type: array
@@ -26379,7 +26921,7 @@ paths:
type: integer
format: int64
examples:
- default: &180
+ default: &184
value:
- timestamp: '2024-09-11T15:00:00Z'
total_request_count: 34225
@@ -26416,18 +26958,18 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user
parameters:
- *94
- - *177
- - *171
- - *172
- - *178
+ - *181
+ - *175
+ - *176
+ - *182
responses:
'200':
description: Response
content:
application/json:
- schema: *179
+ schema: *183
examples:
- default: *180
+ default: *184
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26445,19 +26987,19 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor
parameters:
- *94
+ - *179
+ - *180
- *175
- *176
- - *171
- - *172
- - *178
+ - *182
responses:
'200':
description: Response
content:
application/json:
- schema: *179
+ schema: *183
examples:
- default: *180
+ default: *184
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26475,13 +27017,13 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-user-stats
parameters:
- *94
- - *177
- - *171
- - *172
+ - *181
+ - *175
+ - *176
- *19
- *17
- *48
- - *181
+ - *185
- name: actor_name_substring
in: query
description: Providing a substring will filter results where the actor name
@@ -26562,7 +27104,7 @@ paths:
application/json:
schema: *22
examples:
- default: &469
+ default: &472
value:
id: 1
account:
@@ -26728,12 +27270,12 @@ paths:
application/json:
schema:
anyOf:
- - &183
+ - &187
title: Interaction Limits
description: Interaction limit settings.
type: object
properties:
- limit: &182
+ limit: &186
type: string
description: The type of GitHub user that can comment, open
issues, or create pull requests while the interaction limit
@@ -26758,7 +27300,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &184
+ default: &188
value:
limit: collaborators_only
origin: organization
@@ -26787,13 +27329,13 @@ paths:
required: true
content:
application/json:
- schema: &470
+ schema: &473
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
type: object
properties:
- limit: *182
+ limit: *186
expiry:
type: string
description: 'The duration of the interaction restriction. Default:
@@ -26817,9 +27359,9 @@ paths:
description: Response
content:
application/json:
- schema: *183
+ schema: *187
examples:
- default: *184
+ default: *188
'422': *15
x-github:
githubCloudOnly: false
@@ -26895,9 +27437,9 @@ paths:
application/json:
schema:
type: array
- items: *185
+ items: *189
examples:
- default: *186
+ default: *190
headers:
Link: *58
'404': *6
@@ -26974,7 +27516,7 @@ paths:
description: Response
content:
application/json:
- schema: *185
+ schema: *189
examples:
default:
value:
@@ -27029,7 +27571,7 @@ paths:
url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation
parameters:
- *94
- - &187
+ - &191
name: invitation_id
description: The unique identifier of the invitation.
in: path
@@ -27060,7 +27602,7 @@ paths:
url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams
parameters:
- *94
- - *187
+ - *191
- *17
- *19
responses:
@@ -27070,9 +27612,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: &209
+ default: &212
value:
- id: 1
node_id: MDQ6VGVhbTE=
@@ -27115,7 +27657,7 @@ paths:
application/json:
schema:
type: array
- items: *189
+ items: *192
examples:
default:
value:
@@ -27200,9 +27742,9 @@ paths:
description: Response
content:
application/json:
- schema: *189
+ schema: *192
examples:
- default: &190
+ default: &193
value:
id: 410
node_id: IT_kwDNAd3NAZo
@@ -27235,7 +27777,7 @@ paths:
url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization
parameters:
- *94
- - &191
+ - &194
name: issue_type_id
description: The unique identifier of the issue type.
in: path
@@ -27288,9 +27830,9 @@ paths:
description: Response
content:
application/json:
- schema: *189
+ schema: *192
examples:
- default: *190
+ default: *193
'404': *6
'422': *7
x-github:
@@ -27315,7 +27857,7 @@ paths:
url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization
parameters:
- *94
- - *191
+ - *194
responses:
'204':
description: Response
@@ -27378,7 +27920,7 @@ paths:
- closed
- all
default: open
- - *192
+ - *195
- name: type
description: Can be the name of an issue type.
in: query
@@ -27409,7 +27951,7 @@ paths:
type: array
items: *77
examples:
- default: *193
+ default: *196
headers:
Link: *58
'404': *6
@@ -27467,7 +28009,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'422': *15
@@ -27563,11 +28105,11 @@ paths:
type: integer
codespaces:
type: array
- items: *195
+ items: *198
examples:
- default: *196
+ default: *199
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27592,7 +28134,7 @@ paths:
parameters:
- *94
- *132
- - &197
+ - &200
name: codespace_name
in: path
required: true
@@ -27602,7 +28144,7 @@ paths:
responses:
'202': *47
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27627,15 +28169,15 @@ paths:
parameters:
- *94
- *132
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: &396
+ default: &399
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -27777,7 +28319,7 @@ paths:
recent_folders: []
template:
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27815,7 +28357,7 @@ paths:
description: The user's GitHub Copilot seat details, including usage.
content:
application/json:
- schema: *198
+ schema: *201
examples:
default:
value:
@@ -27858,7 +28400,7 @@ paths:
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
parent:
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27890,7 +28432,7 @@ paths:
description: Response
content:
application/json:
- schema: &200
+ schema: &203
title: Org Membership
description: Org Membership
type: object
@@ -27919,7 +28461,7 @@ paths:
type: string
format: uri
example: https://api.github.com/orgs/octocat
- organization: *199
+ organization: *202
user:
title: Simple User
description: A GitHub user.
@@ -27942,7 +28484,7 @@ paths:
- organization
- user
examples:
- response-if-user-has-an-active-admin-membership-with-organization: &201
+ response-if-user-has-an-active-admin-membership-with-organization: &204
summary: Response if user has an active admin membership with organization
value:
url: https://api.github.com/orgs/octocat/memberships/defunkt
@@ -28039,9 +28581,9 @@ paths:
description: Response
content:
application/json:
- schema: *200
+ schema: *203
examples:
- response-if-user-already-had-membership-with-organization: *201
+ response-if-user-already-had-membership-with-organization: *204
'422': *15
'403': *29
x-github:
@@ -28109,7 +28651,7 @@ paths:
application/json:
schema:
type: array
- items: &202
+ items: &205
title: Migration
description: A migration.
type: object
@@ -28438,7 +28980,7 @@ paths:
description: Response
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -28617,7 +29159,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status
parameters:
- *94
- - &203
+ - &206
name: migration_id
description: The unique identifier of the migration.
in: path
@@ -28644,7 +29186,7 @@ paths:
* `failed`, which means the migration failed.
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -28814,7 +29356,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive
parameters:
- *94
- - *203
+ - *206
responses:
'302':
description: Response
@@ -28836,7 +29378,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive
parameters:
- *94
- - *203
+ - *206
responses:
'204':
description: Response
@@ -28860,8 +29402,8 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository
parameters:
- *94
- - *203
- - &621
+ - *206
+ - &624
name: repo_name
description: repo_name parameter
in: path
@@ -28889,7 +29431,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration
parameters:
- *94
- - *203
+ - *206
- *17
- *19
responses:
@@ -28901,7 +29443,7 @@ paths:
type: array
items: *119
examples:
- default: &216
+ default: &219
value:
- id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -29054,7 +29596,7 @@ paths:
roles:
type: array
description: The list of organization roles available to the organization.
- items: &206
+ items: &209
title: Organization Role
description: Organization roles
type: object
@@ -29202,7 +29744,7 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team
parameters:
- *94
- - &204
+ - &207
name: team_slug
description: The slug of the team name.
in: path
@@ -29234,8 +29776,8 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team
parameters:
- *94
- - *204
- - &205
+ - *207
+ - &208
name: role_id
description: The unique identifier of the role.
in: path
@@ -29271,8 +29813,8 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team
parameters:
- *94
- - *204
- - *205
+ - *207
+ - *208
responses:
'204':
description: Response
@@ -29325,7 +29867,7 @@ paths:
parameters:
- *94
- *132
- - *205
+ - *208
responses:
'204':
description: Response
@@ -29357,7 +29899,7 @@ paths:
parameters:
- *94
- *132
- - *205
+ - *208
responses:
'204':
description: Response
@@ -29386,13 +29928,13 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role
parameters:
- *94
- - *205
+ - *208
responses:
'200':
description: Response
content:
application/json:
- schema: *206
+ schema: *209
examples:
default:
value:
@@ -29443,7 +29985,7 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role
parameters:
- *94
- - *205
+ - *208
- *17
- *19
responses:
@@ -29521,8 +30063,8 @@ paths:
description: Groups of organization members that gives permissions
on specified repositories.
type: object
- properties: *207
- required: *208
+ properties: *210
+ required: *211
nullable: true
required:
- id
@@ -29537,7 +30079,7 @@ paths:
- slug
- parent
examples:
- default: *209
+ default: *212
headers:
Link: *58
'404':
@@ -29567,7 +30109,7 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role
parameters:
- *94
- - *205
+ - *208
- *17
- *19
responses:
@@ -29595,13 +30137,13 @@ paths:
inherited_from:
description: Team the user has gotten the role through
type: array
- items: &254
+ items: &257
title: Team Simple
description: Groups of organization members that gives permissions
on specified repositories.
type: object
- properties: *207
- required: *208
+ properties: *210
+ required: *211
name:
nullable: true
type: string
@@ -29696,7 +30238,7 @@ paths:
- type
- url
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404':
@@ -29744,7 +30286,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -29886,7 +30428,7 @@ paths:
- nuget
- container
- *94
- - &623
+ - &626
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -29922,12 +30464,12 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *211
+ default: *214
'403': *29
'401': *25
- '400': &625
+ '400': &628
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -29949,7 +30491,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization
parameters:
- - &212
+ - &215
name: package_type
description: The type of supported package. Packages in GitHub's Gradle registry
have the type `maven`. Docker images pushed to GitHub's Container registry
@@ -29967,7 +30509,7 @@ paths:
- docker
- nuget
- container
- - &213
+ - &216
name: package_name
description: The name of the package.
in: path
@@ -29980,7 +30522,7 @@ paths:
description: Response
content:
application/json:
- schema: *210
+ schema: *213
examples:
default:
value:
@@ -30032,8 +30574,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
responses:
'204':
@@ -30066,8 +30608,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
- name: token
description: package token
@@ -30100,8 +30642,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
- *19
- *17
@@ -30122,7 +30664,7 @@ paths:
application/json:
schema:
type: array
- items: &214
+ items: &217
title: Package Version
description: A version of a software package
type: object
@@ -30247,10 +30789,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
- - &215
+ - &218
name: package_version_id
description: Unique identifier of the package version.
in: path
@@ -30262,7 +30804,7 @@ paths:
description: Response
content:
application/json:
- schema: *214
+ schema: *217
examples:
default:
value:
@@ -30298,10 +30840,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization
parameters:
- - *212
- - *213
- - *94
- *215
+ - *216
+ - *94
+ - *218
responses:
'204':
description: Response
@@ -30333,10 +30875,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization
parameters:
- - *212
- - *213
- - *94
- *215
+ - *216
+ - *94
+ - *218
responses:
'204':
description: Response
@@ -30366,7 +30908,7 @@ paths:
- *94
- *17
- *19
- - &217
+ - &220
name: sort
description: The property by which to sort the results.
in: query
@@ -30377,7 +30919,7 @@ paths:
- created_at
default: created_at
- *48
- - &218
+ - &221
name: owner
description: A list of owner usernames to use to filter the results.
in: query
@@ -30388,7 +30930,7 @@ paths:
items:
type: string
example: owner[]=octocat1,owner[]=octocat2
- - &219
+ - &222
name: repository
description: The name of the repository to use to filter the results.
in: query
@@ -30396,7 +30938,7 @@ paths:
schema:
type: string
example: Hello-World
- - &220
+ - &223
name: permission
description: The permission to use to filter the results.
in: query
@@ -30404,7 +30946,7 @@ paths:
schema:
type: string
example: issues_read
- - &221
+ - &224
name: last_used_before
description: 'Only show fine-grained personal access tokens used before the
given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -30414,7 +30956,7 @@ paths:
schema:
type: string
format: date-time
- - &222
+ - &225
name: last_used_after
description: 'Only show fine-grained personal access tokens used after the
given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -30424,7 +30966,7 @@ paths:
schema:
type: string
format: date-time
- - &223
+ - &226
name: token_id
description: The ID of the token
in: query
@@ -30436,7 +30978,7 @@ paths:
type: string
example: token_id[]=1,token_id[]=2
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
@@ -30629,7 +31171,7 @@ paths:
action: deny
reason: Access is too broad.
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
@@ -30690,11 +31232,11 @@ paths:
action: deny
reason: This request is denied because the access is too broad.
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -30726,7 +31268,7 @@ paths:
- *17
- *19
responses:
- '500': *145
+ '500': *148
'404': *6
'403': *29
'200':
@@ -30737,7 +31279,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -30763,16 +31305,16 @@ paths:
- *94
- *17
- *19
- - *217
- - *48
- - *218
- - *219
- *220
+ - *48
- *221
- *222
- *223
+ - *224
+ - *225
+ - *226
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
@@ -30954,7 +31496,7 @@ paths:
- 1296269
- 1296280
responses:
- '500': *145
+ '500': *148
'404': *6
'202': *47
'403': *29
@@ -31007,9 +31549,9 @@ paths:
value:
action: revoke
responses:
- '500': *145
+ '500': *148
'404': *6
- '204': *142
+ '204': *145
'403': *29
'422': *15
x-github:
@@ -31041,7 +31583,7 @@ paths:
- *17
- *19
responses:
- '500': *145
+ '500': *148
'404': *6
'403': *29
'200':
@@ -31052,7 +31594,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -31096,7 +31638,7 @@ paths:
type: integer
configurations:
type: array
- items: &224
+ items: &227
title: Organization private registry
description: Private registry configuration for an organization
type: object
@@ -31302,7 +31844,7 @@ paths:
- created_at
- updated_at
examples:
- org-private-registry-with-selected-visibility: &225
+ org-private-registry-with-selected-visibility: &228
value:
name: MAVEN_REPOSITORY_SECRET
registry_type: maven_repository
@@ -31402,9 +31944,9 @@ paths:
description: The specified private registry configuration for the organization
content:
application/json:
- schema: *224
+ schema: *227
examples:
- default: *225
+ default: *228
'404': *6
x-github:
githubCloudOnly: false
@@ -31554,7 +32096,7 @@ paths:
application/json:
schema:
type: array
- items: &226
+ items: &229
title: Project
description: Projects are a way to organize columns and cards of
work.
@@ -31727,7 +32269,7 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
default:
value:
@@ -31765,7 +32307,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '410': &285
+ '410': &288
description: Gone
content:
application/json:
@@ -31800,7 +32342,7 @@ paths:
application/json:
schema:
type: array
- items: &227
+ items: &230
title: Organization Custom Property
description: Custom property defined on an organization
type: object
@@ -31866,7 +32408,7 @@ paths:
- property_name
- value_type
examples:
- default: &228
+ default: &231
value:
- property_name: environment
url: https://api.github.com/orgs/github/properties/schema/environment
@@ -31925,7 +32467,7 @@ paths:
properties:
type: array
description: The array of custom properties to create or update.
- items: *227
+ items: *230
minItems: 1
maxItems: 100
required:
@@ -31955,9 +32497,9 @@ paths:
application/json:
schema:
type: array
- items: *227
+ items: *230
examples:
- default: *228
+ default: *231
'403': *29
'404': *6
x-github:
@@ -31979,7 +32521,7 @@ paths:
url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization
parameters:
- *94
- - &229
+ - &232
name: custom_property_name
description: The custom property name
in: path
@@ -31991,9 +32533,9 @@ paths:
description: Response
content:
application/json:
- schema: *227
+ schema: *230
examples:
- default: &230
+ default: &233
value:
property_name: environment
url: https://api.github.com/orgs/github/properties/schema/environment
@@ -32028,7 +32570,7 @@ paths:
url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization
parameters:
- *94
- - *229
+ - *232
requestBody:
required: true
content:
@@ -32097,9 +32639,9 @@ paths:
description: Response
content:
application/json:
- schema: *227
+ schema: *230
examples:
- default: *230
+ default: *233
'403': *29
'404': *6
x-github:
@@ -32123,9 +32665,9 @@ paths:
url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization
parameters:
- *94
- - *229
+ - *232
responses:
- '204': *142
+ '204': *145
'403': *29
'404': *6
x-github:
@@ -32184,7 +32726,7 @@ paths:
example: octocat/Hello-World
properties:
type: array
- items: &231
+ items: &234
title: Custom Property Value
description: Custom property name and associated value
type: object
@@ -32271,7 +32813,7 @@ paths:
type: array
description: List of custom property names and associated values
to apply to the repositories.
- items: *231
+ items: *234
required:
- repository_names
- properties
@@ -32324,7 +32866,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -32463,7 +33005,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -32665,7 +33207,7 @@ paths:
description: Response
content:
application/json:
- schema: &287
+ schema: &290
title: Full Repository
description: Full Repository
type: object
@@ -32942,8 +33484,8 @@ paths:
title: Repository
description: A repository on GitHub.
type: object
- properties: *232
- required: *233
+ properties: *235
+ required: *236
nullable: true
temp_clone_token:
type: string
@@ -33058,7 +33600,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &418
+ properties: &421
url:
type: string
format: uri
@@ -33074,12 +33616,12 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &419
+ required: &422
- url
- key
- name
- html_url
- security_and_analysis: *234
+ security_and_analysis: *237
custom_properties:
type: object
description: The custom properties that were defined for the repository.
@@ -33163,7 +33705,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &289
+ default: &292
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -33684,7 +34226,7 @@ paths:
- *94
- *17
- *19
- - &558
+ - &561
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -33702,7 +34244,7 @@ paths:
application/json:
schema:
type: array
- items: &241
+ items: &244
title: Repository ruleset
type: object
description: A set of rules to apply when specified conditions are
@@ -33737,7 +34279,7 @@ paths:
source:
type: string
description: The name of the source
- enforcement: &237
+ enforcement: &240
type: string
description: The enforcement level of the ruleset. `evaluate`
allows admins to test rules before enforcing them. Admins
@@ -33750,7 +34292,7 @@ paths:
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: &238
+ items: &241
title: Repository Ruleset Bypass Actor
type: object
description: An actor that can bypass rules in a ruleset
@@ -33815,7 +34357,7 @@ paths:
conditions:
nullable: true
anyOf:
- - &235
+ - &238
title: Repository ruleset conditions for ref names
type: object
description: Parameters for a repository ruleset ref name
@@ -33839,7 +34381,7 @@ paths:
match.
items:
type: string
- - &239
+ - &242
title: Organization ruleset conditions
type: object
description: |-
@@ -33853,7 +34395,7 @@ paths:
description: Conditions to target repositories by name and
refs by name
allOf:
- - *235
+ - *238
- title: Repository ruleset conditions for repository names
type: object
description: Parameters for a repository name condition
@@ -33887,7 +34429,7 @@ paths:
description: Conditions to target repositories by id and
refs by name
allOf:
- - *235
+ - *238
- title: Repository ruleset conditions for repository IDs
type: object
description: Parameters for a repository ID condition
@@ -33909,7 +34451,7 @@ paths:
description: Conditions to target repositories by property
and refs by name
allOf:
- - *235
+ - *238
- title: Repository ruleset conditions for repository properties
type: object
description: Parameters for a repository property condition
@@ -33922,7 +34464,7 @@ paths:
description: The repository properties and values
to include. All of these properties must match
for the condition to pass.
- items: &236
+ items: &239
title: Repository ruleset property targeting
definition
type: object
@@ -33955,17 +34497,17 @@ paths:
description: The repository properties and values
to exclude. The condition will not pass if any
of these properties match.
- items: *236
+ items: *239
required:
- repository_property
rules:
type: array
- items: &240
+ items: &243
title: Repository Rule
type: object
description: A repository rule.
oneOf:
- - &536
+ - &539
title: creation
description: Only allow users with bypass permission to
create matching refs.
@@ -33977,7 +34519,7 @@ paths:
type: string
enum:
- creation
- - &537
+ - &540
title: update
description: Only allow users with bypass permission to
update matching refs.
@@ -33998,7 +34540,7 @@ paths:
repository
required:
- update_allows_fetch_and_merge
- - &539
+ - &542
title: deletion
description: Only allow users with bypass permissions to
delete matching refs.
@@ -34010,7 +34552,7 @@ paths:
type: string
enum:
- deletion
- - &540
+ - &543
title: required_linear_history
description: Prevent merge commits from being pushed to
matching refs.
@@ -34022,7 +34564,7 @@ paths:
type: string
enum:
- required_linear_history
- - &541
+ - &544
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -34100,7 +34642,7 @@ paths:
- merge_method
- min_entries_to_merge
- min_entries_to_merge_wait_minutes
- - &542
+ - &545
title: required_deployments
description: Choose which environments must be successfully
deployed to before refs can be pushed into a ref that
@@ -34124,7 +34666,7 @@ paths:
type: string
required:
- required_deployment_environments
- - &543
+ - &546
title: required_signatures
description: Commits pushed to matching refs must have verified
signatures.
@@ -34136,7 +34678,7 @@ paths:
type: string
enum:
- required_signatures
- - &544
+ - &547
title: pull_request
description: Require all commits be made to a non-target
branch and submitted via a pull request before they can
@@ -34165,11 +34707,9 @@ paths:
- rebase
automatic_copilot_code_review_enabled:
type: boolean
- description: |-
- > [!NOTE]
- > `automatic_copilot_code_review_enabled` is in beta and subject to change.
-
- Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.
+ description: Automatically request review from Copilot
+ for new pull requests, if the author has access
+ to Copilot code review.
dismiss_stale_reviews_on_push:
type: boolean
description: New, reviewable commits pushed will
@@ -34200,7 +34740,7 @@ paths:
- require_last_push_approval
- required_approving_review_count
- required_review_thread_resolution
- - &545
+ - &548
title: required_status_checks
description: Choose which status checks must pass before
the ref is updated. When enabled, commits must first be
@@ -34248,7 +34788,7 @@ paths:
required:
- required_status_checks
- strict_required_status_checks_policy
- - &546
+ - &549
title: non_fast_forward
description: Prevent users with push access from force pushing
to refs.
@@ -34260,7 +34800,7 @@ paths:
type: string
enum:
- non_fast_forward
- - &547
+ - &550
title: commit_message_pattern
description: Parameters to be used for the commit_message_pattern
rule
@@ -34296,7 +34836,7 @@ paths:
required:
- operator
- pattern
- - &548
+ - &551
title: commit_author_email_pattern
description: Parameters to be used for the commit_author_email_pattern
rule
@@ -34332,7 +34872,7 @@ paths:
required:
- operator
- pattern
- - &549
+ - &552
title: committer_email_pattern
description: Parameters to be used for the committer_email_pattern
rule
@@ -34368,7 +34908,7 @@ paths:
required:
- operator
- pattern
- - &550
+ - &553
title: branch_name_pattern
description: Parameters to be used for the branch_name_pattern
rule
@@ -34404,7 +34944,7 @@ paths:
required:
- operator
- pattern
- - &551
+ - &554
title: tag_name_pattern
description: Parameters to be used for the tag_name_pattern
rule
@@ -34440,7 +34980,7 @@ paths:
required:
- operator
- pattern
- - &552
+ - &555
title: file_path_restriction
description: Prevent commits that include changes in specified
file and folder paths from being pushed to the commit
@@ -34465,7 +35005,7 @@ paths:
type: string
required:
- restricted_file_paths
- - &553
+ - &556
title: max_file_path_length
description: Prevent commits that include file paths that
exceed the specified character limit from being pushed
@@ -34489,7 +35029,7 @@ paths:
maximum: 256
required:
- max_file_path_length
- - &554
+ - &557
title: file_extension_restriction
description: Prevent commits that include files with specified
file extensions from being pushed to the commit graph.
@@ -34512,7 +35052,7 @@ paths:
type: string
required:
- restricted_file_extensions
- - &555
+ - &558
title: max_file_size
description: Prevent commits with individual files that
exceed the specified limit from being pushed to the commit
@@ -34537,7 +35077,7 @@ paths:
maximum: 100
required:
- max_file_size
- - &556
+ - &559
title: workflows
description: Require all changes made to a targeted branch
to pass the specified workflows before they can be merged.
@@ -34587,7 +35127,7 @@ paths:
- repository_id
required:
- workflows
- - &557
+ - &560
title: code_scanning
description: Choose which tools must provide code scanning
results before the reference is updated. When configured,
@@ -34684,7 +35224,7 @@ paths:
created_at: '2023-08-15T08:43:03Z'
updated_at: '2023-09-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
post:
summary: Create an organization repository ruleset
description: Create a repository ruleset for an organization.
@@ -34721,16 +35261,16 @@ paths:
- push
- repository
default: branch
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *239
+ items: *241
+ conditions: *242
rules:
type: array
description: An array of rules within the ruleset.
- items: *240
+ items: *243
required:
- name
- enforcement
@@ -34768,9 +35308,9 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: &242
+ default: &245
value:
id: 21
name: super cool ruleset
@@ -34810,7 +35350,7 @@ paths:
created_at: '2023-08-15T08:43:03Z'
updated_at: '2023-09-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
"/orgs/{org}/rulesets/rule-suites":
get:
summary: List organization rule suites
@@ -34825,7 +35365,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *94
- - &559
+ - &562
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
@@ -34840,7 +35380,7 @@ paths:
in: query
schema:
type: string
- - &560
+ - &563
name: time_period
description: |-
The time period to filter by.
@@ -34856,14 +35396,14 @@ paths:
- week
- month
default: day
- - &561
+ - &564
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
- - &562
+ - &565
name: rule_suite_result
description: The rule results to filter on. When specified, only suites with
this result will be returned.
@@ -34883,7 +35423,7 @@ paths:
description: Response
content:
application/json:
- schema: &563
+ schema: &566
title: Rule Suites
description: Response
type: array
@@ -34938,7 +35478,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &564
+ default: &567
value:
- id: 21
actor_id: 12
@@ -34962,7 +35502,7 @@ paths:
result: pass
evaluation_result: fail
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -34982,7 +35522,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *94
- - &565
+ - &568
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -34998,7 +35538,7 @@ paths:
description: Response
content:
application/json:
- schema: &566
+ schema: &569
title: Rule Suite
description: Response
type: object
@@ -35097,7 +35637,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &567
+ default: &570
value:
id: 21
actor_id: 12
@@ -35132,7 +35672,7 @@ paths:
result: fail
rule_type: commit_message_pattern
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -35170,11 +35710,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *242
+ default: *245
'404': *6
- '500': *145
+ '500': *148
put:
summary: Update an organization repository ruleset
description: Update a ruleset for an organization.
@@ -35216,16 +35756,16 @@ paths:
- tag
- push
- repository
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *239
+ items: *241
+ conditions: *242
rules:
description: An array of rules within the ruleset.
type: array
- items: *240
+ items: *243
examples:
default:
value:
@@ -35260,11 +35800,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *242
+ default: *245
'404': *6
- '500': *145
+ '500': *148
delete:
summary: Delete an organization repository ruleset
description: Delete a ruleset for an organization.
@@ -35291,7 +35831,7 @@ paths:
'204':
description: Response
'404': *6
- '500': *145
+ '500': *148
"/orgs/{org}/rulesets/{ruleset_id}/history":
get:
summary: Get organization ruleset history
@@ -35319,7 +35859,7 @@ paths:
application/json:
schema:
type: array
- items: &243
+ items: &246
title: Ruleset version
type: object
description: The historical version of a ruleset
@@ -35343,7 +35883,7 @@ paths:
type: string
format: date-time
examples:
- default: &569
+ default: &572
value:
- version_id: 3
actor:
@@ -35361,7 +35901,7 @@ paths:
type: User
updated_at: '2024-08-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -35396,9 +35936,9 @@ paths:
description: Response
content:
application/json:
- schema: &570
+ schema: &573
allOf:
- - *243
+ - *246
- type: object
required:
- state
@@ -35445,7 +35985,7 @@ paths:
operator: contains
pattern: github
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -35468,14 +36008,14 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *94
- - *244
- - *245
- - *246
- *247
+ - *248
+ - *249
+ - *250
- *48
- *19
- *17
- - &571
+ - &574
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
@@ -35485,7 +36025,7 @@ paths:
required: false
schema:
type: string
- - &572
+ - &575
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
@@ -35495,9 +36035,9 @@ paths:
required: false
schema:
type: string
- - *248
- - *249
- - *250
+ - *251
+ - *252
+ - *253
responses:
'200':
description: Response
@@ -35505,9 +36045,9 @@ paths:
application/json:
schema:
type: array
- items: *251
+ items: *254
examples:
- default: *252
+ default: *255
headers:
Link: *58
'404': *6
@@ -35577,7 +36117,7 @@ paths:
application/json:
schema:
type: array
- items: &579
+ items: &582
description: A repository security advisory.
type: object
properties:
@@ -35797,7 +36337,7 @@ paths:
login:
type: string
description: The username of the user credited.
- type: *253
+ type: *256
credits_detailed:
type: array
nullable: true
@@ -35807,7 +36347,7 @@ paths:
type: object
properties:
user: *4
- type: *253
+ type: *256
state:
type: string
description: The state of the user's acceptance of the
@@ -35831,7 +36371,7 @@ paths:
type: array
description: A list of teams that collaborate on the advisory.
nullable: true
- items: *188
+ items: *152
private_fork:
readOnly: true
nullable: true
@@ -35868,7 +36408,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &580
+ default: &583
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -36255,9 +36795,9 @@ paths:
application/json:
schema:
type: array
- items: *254
+ items: *257
examples:
- default: *209
+ default: *212
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -36281,7 +36821,7 @@ paths:
url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team
parameters:
- *94
- - *204
+ - *207
responses:
'204':
description: Response
@@ -36307,7 +36847,7 @@ paths:
url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team
parameters:
- *94
- - *204
+ - *207
responses:
'204':
description: Response
@@ -36342,7 +36882,7 @@ paths:
description: Response
content:
application/json:
- schema: &639
+ schema: &642
type: object
properties:
total_minutes_used:
@@ -36412,7 +36952,7 @@ paths:
- included_minutes
- minutes_used_breakdown
examples:
- default: &640
+ default: &643
value:
total_minutes_used: 305
total_paid_minutes_used: 0
@@ -36448,7 +36988,7 @@ paths:
description: Response
content:
application/json:
- schema: &641
+ schema: &644
type: object
properties:
total_gigabytes_bandwidth_used:
@@ -36466,7 +37006,7 @@ paths:
- total_paid_gigabytes_bandwidth_used
- included_gigabytes_bandwidth
examples:
- default: &642
+ default: &645
value:
total_gigabytes_bandwidth_used: 50
total_paid_gigabytes_bandwidth_used: 40
@@ -36498,7 +37038,7 @@ paths:
description: Response
content:
application/json:
- schema: &643
+ schema: &646
type: object
properties:
days_left_in_billing_cycle:
@@ -36516,7 +37056,7 @@ paths:
- estimated_paid_storage_for_month
- estimated_storage_for_month
examples:
- default: &644
+ default: &647
value:
days_left_in_billing_cycle: 20
estimated_paid_storage_for_month: 15
@@ -36558,7 +37098,7 @@ paths:
type: integer
network_configurations:
type: array
- items: &255
+ items: &258
title: Hosted compute network configuration
description: A hosted compute network configuration.
type: object
@@ -36678,9 +37218,9 @@ paths:
description: Response
content:
application/json:
- schema: *255
+ schema: *258
examples:
- default: &256
+ default: &259
value:
id: 123456789ABCDEF
name: My network configuration
@@ -36709,7 +37249,7 @@ paths:
url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization
parameters:
- *94
- - &257
+ - &260
name: network_configuration_id
description: Unique identifier of the hosted compute network configuration.
in: path
@@ -36721,9 +37261,9 @@ paths:
description: Response
content:
application/json:
- schema: *255
+ schema: *258
examples:
- default: *256
+ default: *259
headers:
Link: *58
x-github:
@@ -36745,7 +37285,7 @@ paths:
url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization
parameters:
- *94
- - *257
+ - *260
requestBody:
required: true
content:
@@ -36784,9 +37324,9 @@ paths:
description: Response
content:
application/json:
- schema: *255
+ schema: *258
examples:
- default: *256
+ default: *259
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -36806,7 +37346,7 @@ paths:
url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization
parameters:
- *94
- - *257
+ - *260
responses:
'204':
description: Response
@@ -36914,7 +37454,7 @@ paths:
url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team
parameters:
- *94
- - *204
+ - *207
- name: since
description: Show usage metrics since this date. This is a timestamp in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`).
@@ -36946,13 +37486,13 @@ paths:
application/json:
schema:
type: array
- items: *258
+ items: *261
examples:
- default: *259
- '500': *145
+ default: *262
+ '500': *148
'403': *29
'404': *6
- '422': *260
+ '422': *263
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -36980,9 +37520,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
headers:
Link: *58
'403': *29
@@ -37076,7 +37616,7 @@ paths:
description: Response
content:
application/json:
- schema: &261
+ schema: &264
title: Full Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -37139,8 +37679,8 @@ paths:
description: Groups of organization members that gives permissions
on specified repositories.
type: object
- properties: *207
- required: *208
+ properties: *210
+ required: *211
nullable: true
members_count:
type: integer
@@ -37386,7 +37926,7 @@ paths:
- repos_count
- organization
examples:
- default: &262
+ default: &265
value:
id: 1
node_id: MDQ6VGVhbTE=
@@ -37457,15 +37997,15 @@ paths:
url: https://docs.github.com/rest/teams/teams#get-a-team-by-name
parameters:
- *94
- - *204
+ - *207
responses:
'200':
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
x-github:
githubCloudOnly: false
@@ -37487,7 +38027,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#update-a-team
parameters:
- *94
- - *204
+ - *207
requestBody:
required: false
content:
@@ -37549,16 +38089,16 @@ paths:
description: Response when the updated information already exists
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'201':
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
'422': *15
'403': *29
@@ -37584,7 +38124,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#delete-a-team
parameters:
- *94
- - *204
+ - *207
responses:
'204':
description: Response
@@ -37611,7 +38151,7 @@ paths:
url: https://docs.github.com/rest/teams/discussions#list-discussions
parameters:
- *94
- - *204
+ - *207
- *48
- *17
- *19
@@ -37628,7 +38168,7 @@ paths:
application/json:
schema:
type: array
- items: &263
+ items: &266
title: Team Discussion
description: A team discussion is a persistent record of a free-form
conversation within a team.
@@ -37727,7 +38267,7 @@ paths:
- updated_at
- url
examples:
- default: &594
+ default: &597
value:
- author:
login: octocat
@@ -37802,7 +38342,7 @@ paths:
url: https://docs.github.com/rest/teams/discussions#create-a-discussion
parameters:
- *94
- - *204
+ - *207
requestBody:
required: true
content:
@@ -37836,9 +38376,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: &264
+ default: &267
value:
author:
login: octocat
@@ -37911,8 +38451,8 @@ paths:
url: https://docs.github.com/rest/teams/discussions#get-a-discussion
parameters:
- *94
- - *204
- - &265
+ - *207
+ - &268
name: discussion_number
description: The number that identifies the discussion.
in: path
@@ -37924,9 +38464,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *264
+ default: *267
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -37949,8 +38489,8 @@ paths:
url: https://docs.github.com/rest/teams/discussions#update-a-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
requestBody:
required: false
content:
@@ -37973,9 +38513,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: &595
+ default: &598
value:
author:
login: octocat
@@ -38046,8 +38586,8 @@ paths:
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
responses:
'204':
description: Response
@@ -38074,8 +38614,8 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
- *48
- *17
- *19
@@ -38086,7 +38626,7 @@ paths:
application/json:
schema:
type: array
- items: &266
+ items: &269
title: Team Discussion Comment
description: A reply to a discussion within a team.
type: object
@@ -38158,7 +38698,7 @@ paths:
- updated_at
- url
examples:
- default: &596
+ default: &599
value:
- author:
login: octocat
@@ -38227,8 +38767,8 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
requestBody:
required: true
content:
@@ -38250,9 +38790,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: &267
+ default: &270
value:
author:
login: octocat
@@ -38319,9 +38859,9 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment
parameters:
- *94
- - *204
- - *265
- - &268
+ - *207
+ - *268
+ - &271
name: comment_number
description: The number that identifies the comment.
in: path
@@ -38333,9 +38873,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *267
+ default: *270
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -38358,9 +38898,9 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
requestBody:
required: true
content:
@@ -38382,9 +38922,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: &597
+ default: &600
value:
author:
login: octocat
@@ -38449,9 +38989,9 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
responses:
'204':
description: Response
@@ -38478,9 +39018,9 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion comment.
@@ -38506,7 +39046,7 @@ paths:
application/json:
schema:
type: array
- items: &269
+ items: &272
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -38549,7 +39089,7 @@ paths:
- content
- created_at
examples:
- default: &271
+ default: &274
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -38600,9 +39140,9 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
requestBody:
required: true
content:
@@ -38635,9 +39175,9 @@ paths:
team discussion comment
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: &270
+ default: &273
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -38666,9 +39206,9 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -38692,10 +39232,10 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
- - &272
+ - *271
+ - &275
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -38728,8 +39268,8 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion.
@@ -38755,9 +39295,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
x-github:
@@ -38784,8 +39324,8 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
requestBody:
required: true
content:
@@ -38817,16 +39357,16 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -38850,9 +39390,9 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction
parameters:
- *94
- - *204
- - *265
- - *272
+ - *207
+ - *268
+ - *275
responses:
'204':
description: Response
@@ -38877,7 +39417,7 @@ paths:
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -38887,9 +39427,9 @@ paths:
application/json:
schema:
type: array
- items: *185
+ items: *189
examples:
- default: *186
+ default: *190
headers:
Link: *58
x-github:
@@ -38912,7 +39452,7 @@ paths:
url: https://docs.github.com/rest/teams/members#list-team-members
parameters:
- *94
- - *204
+ - *207
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -38935,7 +39475,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -38966,14 +39506,14 @@ paths:
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user
parameters:
- *94
- - *204
+ - *207
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: &273
+ schema: &276
title: Team Membership
description: Team Membership
type: object
@@ -39000,7 +39540,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &598
+ response-if-user-is-a-team-maintainer: &601
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -39037,7 +39577,7 @@ paths:
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user
parameters:
- *94
- - *204
+ - *207
- *132
requestBody:
required: false
@@ -39063,9 +39603,9 @@ paths:
description: Response
content:
application/json:
- schema: *273
+ schema: *276
examples:
- response-if-users-membership-with-team-is-now-pending: &599
+ response-if-users-membership-with-team-is-now-pending: &602
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -39101,7 +39641,7 @@ paths:
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user
parameters:
- *94
- - *204
+ - *207
- *132
responses:
'204':
@@ -39128,7 +39668,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#list-team-projects
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -39138,7 +39678,7 @@ paths:
application/json:
schema:
type: array
- items: &274
+ items: &277
title: Team Project
description: A team's access to a project.
type: object
@@ -39206,7 +39746,7 @@ paths:
- updated_at
- permissions
examples:
- default: &600
+ default: &603
value:
- owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -39270,8 +39810,8 @@ paths:
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project
parameters:
- *94
- - *204
- - &275
+ - *207
+ - &278
name: project_id
description: The unique identifier of the project.
in: path
@@ -39283,9 +39823,9 @@ paths:
description: Response
content:
application/json:
- schema: *274
+ schema: *277
examples:
- default: &601
+ default: &604
value:
owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -39348,8 +39888,8 @@ paths:
url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions
parameters:
- *94
- - *204
- - *275
+ - *207
+ - *278
requestBody:
required: false
content:
@@ -39416,8 +39956,8 @@ paths:
url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team
parameters:
- *94
- - *204
- - *275
+ - *207
+ - *278
responses:
'204':
description: Response
@@ -39445,7 +39985,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#list-team-repositories
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -39457,7 +39997,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -39487,15 +40027,15 @@ paths:
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository
parameters:
- *94
- - *204
- - *276
- - *277
+ - *207
+ - *279
+ - *280
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &602
+ schema: &605
title: Team Repository
description: A team's access to a repository.
type: object
@@ -40065,9 +40605,9 @@ paths:
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions
parameters:
- *94
- - *204
- - *276
- - *277
+ - *207
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -40113,9 +40653,9 @@ paths:
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team
parameters:
- *94
- - *204
- - *276
- - *277
+ - *207
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -40140,7 +40680,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#list-child-teams
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -40150,9 +40690,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- response-if-child-teams-exist: &603
+ response-if-child-teams-exist: &606
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -40279,7 +40819,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#get-a-project-card
parameters:
- - &278
+ - &281
name: card_id
description: The unique identifier of the card.
in: path
@@ -40291,7 +40831,7 @@ paths:
description: Response
content:
application/json:
- schema: &279
+ schema: &282
title: Project Card
description: Project cards represent a scope of work.
type: object
@@ -40358,7 +40898,7 @@ paths:
- created_at
- updated_at
examples:
- default: &280
+ default: &283
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
@@ -40414,7 +40954,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card
parameters:
- - *278
+ - *281
requestBody:
required: false
content:
@@ -40441,9 +40981,9 @@ paths:
description: Response
content:
application/json:
- schema: *279
+ schema: *282
examples:
- default: *280
+ default: *283
'304': *37
'403': *29
'401': *25
@@ -40470,7 +41010,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#delete-a-project-card
parameters:
- - *278
+ - *281
responses:
'204':
description: Response
@@ -40514,7 +41054,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#move-a-project-card
parameters:
- - *278
+ - *281
requestBody:
required: true
content:
@@ -40625,7 +41165,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#get-a-project-column
parameters:
- - &281
+ - &284
name: column_id
description: The unique identifier of the column.
in: path
@@ -40637,7 +41177,7 @@ paths:
description: Response
content:
application/json:
- schema: &282
+ schema: &285
title: Project Column
description: Project columns contain cards of work.
type: object
@@ -40683,7 +41223,7 @@ paths:
- created_at
- updated_at
examples:
- default: &283
+ default: &286
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
@@ -40718,7 +41258,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column
parameters:
- - *281
+ - *284
requestBody:
required: true
content:
@@ -40742,9 +41282,9 @@ paths:
description: Response
content:
application/json:
- schema: *282
+ schema: *285
examples:
- default: *283
+ default: *286
'304': *37
'403': *29
'401': *25
@@ -40769,7 +41309,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#delete-a-project-column
parameters:
- - *281
+ - *284
responses:
'204':
description: Response
@@ -40798,7 +41338,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#list-project-cards
parameters:
- - *281
+ - *284
- name: archived_state
description: Filters the project cards that are returned by the card's state.
in: query
@@ -40819,7 +41359,7 @@ paths:
application/json:
schema:
type: array
- items: *279
+ items: *282
examples:
default:
value:
@@ -40878,7 +41418,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#create-a-project-card
parameters:
- - *281
+ - *284
requestBody:
required: true
content:
@@ -40918,9 +41458,9 @@ paths:
description: Response
content:
application/json:
- schema: *279
+ schema: *282
examples:
- default: *280
+ default: *283
'304': *37
'403': *29
'401': *25
@@ -40976,7 +41516,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#move-a-project-column
parameters:
- - *281
+ - *284
requestBody:
required: true
content:
@@ -41036,15 +41576,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#get-a-project
parameters:
- - *275
+ - *278
responses:
'200':
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
- default: &284
+ default: &287
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
@@ -41101,7 +41641,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#update-a-project
parameters:
- - *275
+ - *278
requestBody:
required: false
content:
@@ -41147,9 +41687,9 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
- default: *284
+ default: *287
'404':
description: Not Found if the authenticated user does not have access to
the project
@@ -41170,7 +41710,7 @@ paths:
items:
type: string
'401': *25
- '410': *285
+ '410': *288
'422': *7
x-github:
githubCloudOnly: false
@@ -41193,7 +41733,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#delete-a-project
parameters:
- - *275
+ - *278
responses:
'204':
description: Delete Success
@@ -41214,7 +41754,7 @@ paths:
items:
type: string
'401': *25
- '410': *285
+ '410': *288
'404': *6
x-github:
githubCloudOnly: false
@@ -41238,7 +41778,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators
parameters:
- - *275
+ - *278
- 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
@@ -41265,7 +41805,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404': *6
@@ -41295,7 +41835,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator
parameters:
- - *275
+ - *278
- *132
requestBody:
required: false
@@ -41348,7 +41888,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator
parameters:
- - *275
+ - *278
- *132
responses:
'204':
@@ -41380,7 +41920,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user
parameters:
- - *275
+ - *278
- *132
responses:
'200':
@@ -41454,7 +41994,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#list-project-columns
parameters:
- - *275
+ - *278
- *17
- *19
responses:
@@ -41464,7 +42004,7 @@ paths:
application/json:
schema:
type: array
- items: *282
+ items: *285
examples:
default:
value:
@@ -41502,7 +42042,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#create-a-project-column
parameters:
- - *275
+ - *278
requestBody:
required: true
content:
@@ -41525,7 +42065,7 @@ paths:
description: Response
content:
application/json:
- schema: *282
+ schema: *285
examples:
default:
value:
@@ -41589,7 +42129,7 @@ paths:
resources:
type: object
properties:
- core: &286
+ core: &289
title: Rate Limit
type: object
properties:
@@ -41606,20 +42146,20 @@ paths:
- remaining
- reset
- used
- graphql: *286
- search: *286
- code_search: *286
- source_import: *286
- integration_manifest: *286
- code_scanning_upload: *286
- actions_runner_registration: *286
- scim: *286
- dependency_snapshots: *286
- code_scanning_autofix: *286
+ graphql: *289
+ search: *289
+ code_search: *289
+ source_import: *289
+ integration_manifest: *289
+ code_scanning_upload: *289
+ actions_runner_registration: *289
+ scim: *289
+ dependency_snapshots: *289
+ code_scanning_autofix: *289
required:
- core
- search
- rate: *286
+ rate: *289
required:
- rate
- resources
@@ -41723,14 +42263,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
default-response:
summary: Default response
@@ -42231,7 +42771,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *288
+ '301': *291
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42249,8 +42789,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -42494,10 +43034,10 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
- '307': &290
+ default: *292
+ '307': &293
description: Temporary Redirect
content:
application/json:
@@ -42526,8 +43066,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -42549,7 +43089,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *290
+ '307': *293
'404': *6
x-github:
githubCloudOnly: false
@@ -42572,11 +43112,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- - &316
+ - &319
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -42599,7 +43139,7 @@ paths:
type: integer
artifacts:
type: array
- items: &291
+ items: &294
title: Artifact
description: An artifact
type: object
@@ -42677,7 +43217,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &317
+ default: &320
value:
total_count: 2
artifacts:
@@ -42738,9 +43278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *276
- - *277
- - &292
+ - *279
+ - *280
+ - &295
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -42752,7 +43292,7 @@ paths:
description: Response
content:
application/json:
- schema: *291
+ schema: *294
examples:
default:
value:
@@ -42790,9 +43330,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *276
- - *277
- - *292
+ - *279
+ - *280
+ - *295
responses:
'204':
description: Response
@@ -42816,9 +43356,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *276
- - *277
- - *292
+ - *279
+ - *280
+ - *295
- name: archive_format
in: path
required: true
@@ -42832,7 +43372,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': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42855,14 +43395,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *293
+ schema: *296
examples:
default:
value:
@@ -42888,11 +43428,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- - &294
+ - &297
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/<branch name>`. To reference
@@ -42926,7 +43466,7 @@ paths:
description: Response
content:
application/json:
- schema: &295
+ schema: &298
title: Repository actions caches
description: Repository actions caches
type: object
@@ -42968,7 +43508,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &296
+ default: &299
value:
total_count: 1
actions_caches:
@@ -43000,23 +43540,23 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *294
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *295
+ schema: *298
examples:
- default: *296
+ default: *299
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -43036,8 +43576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -43068,9 +43608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *276
- - *277
- - &297
+ - *279
+ - *280
+ - &300
name: job_id
description: The unique identifier of the job.
in: path
@@ -43082,7 +43622,7 @@ paths:
description: Response
content:
application/json:
- schema: &320
+ schema: &323
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -43389,9 +43929,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *276
- - *277
- - *297
+ - *279
+ - *280
+ - *300
responses:
'302':
description: Response
@@ -43419,9 +43959,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *276
- - *277
- - *297
+ - *279
+ - *280
+ - *300
requestBody:
required: false
content:
@@ -43466,8 +44006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Status response
@@ -43517,8 +44057,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -43581,8 +44121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -43600,7 +44140,7 @@ paths:
type: integer
secrets:
type: array
- items: &322
+ items: &325
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -43620,7 +44160,7 @@ paths:
- created_at
- updated_at
examples:
- default: &323
+ default: &326
value:
total_count: 2
secrets:
@@ -43653,9 +44193,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *276
- - *277
- - *298
+ - *279
+ - *280
+ - *301
- *19
responses:
'200':
@@ -43672,7 +44212,7 @@ paths:
type: integer
variables:
type: array
- items: &326
+ items: &329
title: Actions Variable
type: object
properties:
@@ -43702,7 +44242,7 @@ paths:
- created_at
- updated_at
examples:
- default: &327
+ default: &330
value:
total_count: 2
variables:
@@ -43735,8 +44275,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -43745,11 +44285,11 @@ paths:
schema:
type: object
properties:
- enabled: &300
+ enabled: &303
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *108
- selected_actions_url: *299
+ selected_actions_url: *302
required:
- enabled
examples:
@@ -43776,8 +44316,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -43788,7 +44328,7 @@ paths:
schema:
type: object
properties:
- enabled: *300
+ enabled: *303
allowed_actions: *108
required:
- enabled
@@ -43818,14 +44358,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: &301
+ schema: &304
type: object
properties:
access_level:
@@ -43842,7 +44382,7 @@ paths:
required:
- access_level
examples:
- default: &302
+ default: &305
value:
access_level: organization
x-github:
@@ -43866,15 +44406,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
application/json:
- schema: *301
+ schema: *304
examples:
- default: *302
+ default: *305
responses:
'204':
description: Response
@@ -43898,8 +44438,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -43926,8 +44466,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -43959,14 +44499,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *303
+ schema: *306
examples:
default: *114
x-github:
@@ -43989,8 +44529,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Success response
@@ -44001,7 +44541,7 @@ paths:
required: true
content:
application/json:
- schema: *304
+ schema: *307
examples:
default: *114
x-github:
@@ -44030,8 +44570,8 @@ paths:
in: query
schema:
type: string
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -44075,8 +44615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -44084,9 +44624,9 @@ paths:
application/json:
schema:
type: array
- items: *305
+ items: *308
examples:
- default: *306
+ default: *309
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44108,8 +44648,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -44152,7 +44692,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *307
+ '201': *310
'404': *6
'422': *7
'409': *46
@@ -44183,8 +44723,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'201':
description: Response
@@ -44192,7 +44732,7 @@ paths:
application/json:
schema: *123
examples:
- default: *308
+ default: *311
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44220,8 +44760,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'201':
description: Response
@@ -44229,7 +44769,7 @@ paths:
application/json:
schema: *123
examples:
- default: *309
+ default: *312
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44251,8 +44791,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
'200':
@@ -44261,7 +44801,7 @@ paths:
application/json:
schema: *121
examples:
- default: *310
+ default: *313
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44282,8 +44822,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
'204':
@@ -44309,8 +44849,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
'200': *125
@@ -44335,8 +44875,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
requestBody:
required: true
@@ -44385,8 +44925,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
requestBody:
required: true
@@ -44436,11 +44976,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
- '200': *311
+ '200': *314
'404': *6
x-github:
githubCloudOnly: false
@@ -44467,10 +45007,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
- - *312
+ - *315
responses:
'200': *125
'404': *6
@@ -44498,9 +45038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *276
- - *277
- - &330
+ - *279
+ - *280
+ - &333
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.
@@ -44508,7 +45048,7 @@ paths:
required: false
schema:
type: string
- - &331
+ - &334
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -44516,7 +45056,7 @@ paths:
required: false
schema:
type: string
- - &332
+ - &335
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -44525,7 +45065,7 @@ paths:
required: false
schema:
type: string
- - &333
+ - &336
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
@@ -44552,7 +45092,7 @@ paths:
- pending
- *17
- *19
- - &334
+ - &337
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/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -44561,7 +45101,7 @@ paths:
schema:
type: string
format: date-time
- - &313
+ - &316
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -44570,13 +45110,13 @@ paths:
schema:
type: boolean
default: false
- - &335
+ - &338
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &336
+ - &339
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -44599,7 +45139,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &314
+ items: &317
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -44694,7 +45234,7 @@ paths:
that triggered the run.
type: array
nullable: true
- items: &355
+ items: &358
title: Pull Request Minimal
type: object
properties:
@@ -44813,7 +45353,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &359
+ properties: &362
id:
type: string
description: SHA for the commit
@@ -44864,7 +45404,7 @@ paths:
- name
- email
nullable: true
- required: &360
+ required: &363
- id
- tree_id
- message
@@ -44911,7 +45451,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &337
+ default: &340
value:
total_count: 1
workflow_runs:
@@ -45147,24 +45687,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *276
- - *277
- - &315
+ - *279
+ - *280
+ - &318
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *313
+ - *316
responses:
'200':
description: Response
content:
application/json:
- schema: *314
+ schema: *317
examples:
- default: &318
+ default: &321
value:
id: 30433642
name: Build
@@ -45405,9 +45945,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'204':
description: Response
@@ -45430,9 +45970,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'200':
description: Response
@@ -45551,9 +46091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'201':
description: Response
@@ -45586,12 +46126,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
- *17
- *19
- - *316
+ - *319
responses:
'200':
description: Response
@@ -45607,9 +46147,9 @@ paths:
type: integer
artifacts:
type: array
- items: *291
+ items: *294
examples:
- default: *317
+ default: *320
headers:
Link: *58
x-github:
@@ -45633,25 +46173,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *276
- - *277
- - *315
- - &319
+ - *279
+ - *280
+ - *318
+ - &322
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *313
+ - *316
responses:
'200':
description: Response
content:
application/json:
- schema: *314
+ schema: *317
examples:
- default: *318
+ default: *321
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -45674,10 +46214,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *276
- - *277
- - *315
- - *319
+ - *279
+ - *280
+ - *318
+ - *322
- *17
- *19
responses:
@@ -45695,9 +46235,9 @@ paths:
type: integer
jobs:
type: array
- items: *320
+ items: *323
examples:
- default: &321
+ default: &324
value:
total_count: 1
jobs:
@@ -45810,10 +46350,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *276
- - *277
- - *315
- - *319
+ - *279
+ - *280
+ - *318
+ - *322
responses:
'302':
description: Response
@@ -45841,9 +46381,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'202':
description: Response
@@ -45876,9 +46416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: true
content:
@@ -45945,9 +46485,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'202':
description: Response
@@ -45980,9 +46520,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
- 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
@@ -46012,9 +46552,9 @@ paths:
type: integer
jobs:
type: array
- items: *320
+ items: *323
examples:
- default: *321
+ default: *324
headers:
Link: *58
x-github:
@@ -46039,9 +46579,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'302':
description: Response
@@ -46068,14 +46608,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'204':
description: Response
'403': *29
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46097,9 +46637,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'200':
description: Response
@@ -46159,7 +46699,7 @@ paths:
items:
type: object
properties:
- type: &439
+ type: &442
type: string
description: The type of reviewer.
enum:
@@ -46169,7 +46709,7 @@ paths:
reviewer:
anyOf:
- *4
- - *188
+ - *152
required:
- environment
- wait_timer
@@ -46244,9 +46784,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: true
content:
@@ -46293,7 +46833,7 @@ paths:
application/json:
schema:
type: array
- items: &434
+ items: &437
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -46399,7 +46939,7 @@ paths:
- created_at
- updated_at
examples:
- default: &435
+ default: &438
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -46455,9 +46995,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: false
content:
@@ -46501,9 +47041,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: false
content:
@@ -46556,9 +47096,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'200':
description: Response
@@ -46695,8 +47235,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -46714,9 +47254,9 @@ paths:
type: integer
secrets:
type: array
- items: *322
+ items: *325
examples:
- default: *323
+ default: *326
headers:
Link: *58
x-github:
@@ -46741,16 +47281,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *324
+ schema: *327
examples:
- default: *325
+ default: *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46772,17 +47312,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *322
+ schema: *325
examples:
- default: &452
+ default: &455
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -46808,8 +47348,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
requestBody:
required: true
@@ -46867,8 +47407,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'204':
@@ -46894,9 +47434,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *276
- - *277
- - *298
+ - *279
+ - *280
+ - *301
- *19
responses:
'200':
@@ -46913,9 +47453,9 @@ paths:
type: integer
variables:
type: array
- items: *326
+ items: *329
examples:
- default: *327
+ default: *330
headers:
Link: *58
x-github:
@@ -46938,8 +47478,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -46991,17 +47531,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
responses:
'200':
description: Response
content:
application/json:
- schema: *326
+ schema: *329
examples:
- default: &453
+ default: &456
value:
name: USERNAME
value: octocat
@@ -47027,8 +47567,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
requestBody:
required: true
@@ -47071,8 +47611,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
responses:
'204':
@@ -47098,8 +47638,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -47117,7 +47657,7 @@ paths:
type: integer
workflows:
type: array
- items: &328
+ items: &331
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -47224,9 +47764,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *276
- - *277
- - &329
+ - *279
+ - *280
+ - &332
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -47241,7 +47781,7 @@ paths:
description: Response
content:
application/json:
- schema: *328
+ schema: *331
examples:
default:
value:
@@ -47274,9 +47814,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'204':
description: Response
@@ -47301,9 +47841,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'204':
description: Response
@@ -47354,9 +47894,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'204':
description: Response
@@ -47383,19 +47923,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *276
- - *277
- - *329
- - *330
- - *331
+ - *279
+ - *280
- *332
- *333
- - *17
- - *19
- *334
- - *313
- *335
- *336
+ - *17
+ - *19
+ - *337
+ - *316
+ - *338
+ - *339
responses:
'200':
description: Response
@@ -47411,9 +47951,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *314
+ items: *317
examples:
- default: *337
+ default: *340
headers:
Link: *58
x-github:
@@ -47445,9 +47985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'200':
description: Response
@@ -47508,8 +48048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *48
- *17
- *39
@@ -47673,8 +48213,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -47686,7 +48226,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404': *6
@@ -47711,8 +48251,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: assignee
in: path
required: true
@@ -47748,8 +48288,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-an-attestation
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -47861,8 +48401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-attestations
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *39
- *40
@@ -47916,7 +48456,7 @@ paths:
bundle_url:
type: string
examples:
- default: *338
+ default: *341
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -47936,8 +48476,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -47945,7 +48485,7 @@ paths:
application/json:
schema:
type: array
- items: &339
+ items: &342
title: Autolink reference
description: An autolink reference.
type: object
@@ -47995,8 +48535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -48035,9 +48575,9 @@ paths:
description: response
content:
application/json:
- schema: *339
+ schema: *342
examples:
- default: &340
+ default: &343
value:
id: 1
key_prefix: TICKET-
@@ -48068,9 +48608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *276
- - *277
- - &341
+ - *279
+ - *280
+ - &344
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -48082,9 +48622,9 @@ paths:
description: Response
content:
application/json:
- schema: *339
+ schema: *342
examples:
- default: *340
+ default: *343
'404': *6
x-github:
githubCloudOnly: false
@@ -48104,9 +48644,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *276
- - *277
- - *341
+ - *279
+ - *280
+ - *344
responses:
'204':
description: Response
@@ -48130,8 +48670,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response if Dependabot is enabled
@@ -48179,8 +48719,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -48201,8 +48741,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -48222,8 +48762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -48261,7 +48801,7 @@ paths:
- url
protected:
type: boolean
- protection: &343
+ protection: &346
title: Branch Protection
description: Branch Protection
type: object
@@ -48303,7 +48843,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &346
+ enforce_admins: &349
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -48318,7 +48858,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &348
+ required_pull_request_reviews: &351
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -48339,7 +48879,7 @@ paths:
description: The list of teams with review dismissal
access.
type: array
- items: *188
+ items: *152
apps:
description: The list of apps with review dismissal
access.
@@ -48368,7 +48908,7 @@ paths:
description: The list of teams allowed to bypass
pull request requirements.
type: array
- items: *188
+ items: *152
apps:
description: The list of apps allowed to bypass
pull request requirements.
@@ -48394,7 +48934,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &345
+ restrictions: &348
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -48701,9 +49241,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *276
- - *277
- - &344
+ - *279
+ - *280
+ - &347
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/graphql).
@@ -48717,14 +49257,14 @@ paths:
description: Response
content:
application/json:
- schema: &354
+ schema: &357
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &407
+ commit: &410
title: Commit
description: Commit
type: object
@@ -48758,7 +49298,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &342
+ properties: &345
name:
type: string
example: '"Chris Wanstrath"'
@@ -48773,7 +49313,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *342
+ properties: *345
nullable: true
message:
type: string
@@ -48794,7 +49334,7 @@ paths:
required:
- sha
- url
- verification: &459
+ verification: &462
title: Verification
type: object
properties:
@@ -48864,7 +49404,7 @@ paths:
type: integer
files:
type: array
- items: &422
+ items: &425
title: Diff Entry
description: Diff Entry
type: object
@@ -48947,7 +49487,7 @@ paths:
- self
protected:
type: boolean
- protection: *343
+ protection: *346
protection_url:
type: string
format: uri
@@ -49054,7 +49594,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *288
+ '301': *291
'404': *6
x-github:
githubCloudOnly: false
@@ -49076,15 +49616,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *346
examples:
default:
value:
@@ -49278,9 +49818,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -49535,7 +50075,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &351
+ required_status_checks: &354
title: Status Check Policy
description: Status Check Policy
type: object
@@ -49611,7 +50151,7 @@ paths:
items: *4
teams:
type: array
- items: *188
+ items: *152
apps:
type: array
items: *5
@@ -49629,7 +50169,7 @@ paths:
items: *4
teams:
type: array
- items: *188
+ items: *152
apps:
type: array
items: *5
@@ -49687,7 +50227,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *345
+ restrictions: *348
required_conversation_resolution:
type: object
properties:
@@ -49799,9 +50339,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -49826,17 +50366,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: &347
+ default: &350
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -49858,17 +50398,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: *347
+ default: *350
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -49887,9 +50427,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -49914,17 +50454,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *348
+ schema: *351
examples:
- default: &349
+ default: &352
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -50020,9 +50560,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50120,9 +50660,9 @@ paths:
description: Response
content:
application/json:
- schema: *348
+ schema: *351
examples:
- default: *349
+ default: *352
'422': *15
x-github:
githubCloudOnly: false
@@ -50143,9 +50683,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50172,17 +50712,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: &350
+ default: &353
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -50205,17 +50745,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: *350
+ default: *353
'404': *6
x-github:
githubCloudOnly: false
@@ -50235,9 +50775,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50262,17 +50802,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *354
examples:
- default: &352
+ default: &355
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -50298,9 +50838,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50352,9 +50892,9 @@ paths:
description: Response
content:
application/json:
- schema: *351
+ schema: *354
examples:
- default: *352
+ default: *355
'404': *6
'422': *15
x-github:
@@ -50376,9 +50916,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50402,9 +50942,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -50438,9 +50978,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50507,9 +51047,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50573,9 +51113,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
content:
application/json:
@@ -50641,15 +51181,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *345
+ schema: *348
examples:
default:
value:
@@ -50740,9 +51280,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50765,9 +51305,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -50777,7 +51317,7 @@ paths:
type: array
items: *5
examples:
- default: &353
+ default: &356
value:
- id: 1
slug: octoapp
@@ -50834,9 +51374,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -50870,7 +51410,7 @@ paths:
type: array
items: *5
examples:
- default: *353
+ default: *356
'422': *15
x-github:
githubCloudOnly: false
@@ -50891,9 +51431,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -50927,7 +51467,7 @@ paths:
type: array
items: *5
examples:
- default: *353
+ default: *356
'422': *15
x-github:
githubCloudOnly: false
@@ -50948,9 +51488,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -50984,7 +51524,7 @@ paths:
type: array
items: *5
examples:
- default: *353
+ default: *356
'422': *15
x-github:
githubCloudOnly: false
@@ -51006,9 +51546,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -51016,9 +51556,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'404': *6
x-github:
githubCloudOnly: false
@@ -51038,9 +51578,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -51076,9 +51616,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'422': *15
x-github:
githubCloudOnly: false
@@ -51099,9 +51639,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -51137,9 +51677,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'422': *15
x-github:
githubCloudOnly: false
@@ -51160,9 +51700,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
content:
application/json:
@@ -51197,9 +51737,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'422': *15
x-github:
githubCloudOnly: false
@@ -51221,9 +51761,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -51233,7 +51773,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'404': *6
x-github:
githubCloudOnly: false
@@ -51257,9 +51797,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51292,7 +51832,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'422': *15
x-github:
githubCloudOnly: false
@@ -51317,9 +51857,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51352,7 +51892,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'422': *15
x-github:
githubCloudOnly: false
@@ -51377,9 +51917,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51412,7 +51952,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'422': *15
x-github:
githubCloudOnly: false
@@ -51439,9 +51979,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51463,7 +52003,7 @@ paths:
description: Response
content:
application/json:
- schema: *354
+ schema: *357
examples:
default:
value:
@@ -51579,8 +52119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -51859,7 +52399,7 @@ paths:
description: Response
content:
application/json:
- schema: &356
+ schema: &359
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -51978,8 +52518,8 @@ paths:
do not necessarily indicate pull requests that triggered the
check.
type: array
- items: *355
- deployment: &653
+ items: *358
+ deployment: &656
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -52259,9 +52799,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *276
- - *277
- - &357
+ - *279
+ - *280
+ - &360
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -52273,9 +52813,9 @@ paths:
description: Response
content:
application/json:
- schema: *356
+ schema: *359
examples:
- default: &358
+ default: &361
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -52375,9 +52915,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *276
- - *277
- - *357
+ - *279
+ - *280
+ - *360
requestBody:
required: true
content:
@@ -52617,9 +53157,9 @@ paths:
description: Response
content:
application/json:
- schema: *356
+ schema: *359
examples:
- default: *358
+ default: *361
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52639,9 +53179,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *276
- - *277
- - *357
+ - *279
+ - *280
+ - *360
- *17
- *19
responses:
@@ -52738,9 +53278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *276
- - *277
- - *357
+ - *279
+ - *280
+ - *360
responses:
'201':
description: Response
@@ -52784,8 +53324,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -52807,7 +53347,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &361
+ schema: &364
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -52871,7 +53411,7 @@ paths:
nullable: true
pull_requests:
type: array
- items: *355
+ items: *358
nullable: true
app:
title: GitHub app
@@ -52893,12 +53433,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &679
+ head_commit: &682
title: Simple Commit
description: A commit.
type: object
- properties: *359
- required: *360
+ properties: *362
+ required: *363
latest_check_runs_count:
type: integer
check_runs_url:
@@ -52926,7 +53466,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &362
+ default: &365
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -53217,9 +53757,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *361
+ schema: *364
examples:
- default: *362
+ default: *365
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53238,8 +53778,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -53548,9 +54088,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *276
- - *277
- - &363
+ - *279
+ - *280
+ - &366
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -53562,9 +54102,9 @@ paths:
description: Response
content:
application/json:
- schema: *361
+ schema: *364
examples:
- default: *362
+ default: *365
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53587,17 +54127,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *276
- - *277
- - *363
- - &415
+ - *279
+ - *280
+ - *366
+ - &418
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &416
+ - &419
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -53636,9 +54176,9 @@ paths:
type: integer
check_runs:
type: array
- items: *356
+ items: *359
examples:
- default: &417
+ default: &420
value:
total_count: 1
check_runs:
@@ -53740,9 +54280,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *276
- - *277
- - *363
+ - *279
+ - *280
+ - *366
responses:
'201':
description: Response
@@ -53775,21 +54315,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *276
- - *277
- - *364
- - *365
+ - *279
+ - *280
+ - *367
+ - *368
- *19
- *17
- - &382
+ - &385
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/<branch name>` or simply
`<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
in: query
required: false
- schema: *366
- - &383
+ schema: *369
+ - &386
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -53814,13 +54354,13 @@ paths:
be returned.
in: query
required: false
- schema: *367
+ schema: *370
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *368
+ schema: *371
responses:
'200':
description: Response
@@ -53833,12 +54373,12 @@ paths:
properties:
number: *54
created_at: *55
- updated_at: *133
+ updated_at: *136
url: *56
html_url: *57
- instances_url: *369
- state: *138
- fixed_at: *134
+ instances_url: *372
+ state: *141
+ fixed_at: *137
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -53846,12 +54386,12 @@ paths:
properties: *20
required: *21
nullable: true
- dismissed_at: *135
- dismissed_reason: *370
- dismissed_comment: *371
- rule: *372
- tool: *373
- most_recent_instance: *374
+ dismissed_at: *138
+ dismissed_reason: *373
+ dismissed_comment: *374
+ rule: *375
+ tool: *376
+ most_recent_instance: *377
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -53974,7 +54514,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &375
+ '403': &378
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -54001,9 +54541,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *276
- - *277
- - &376
+ - *279
+ - *280
+ - &379
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -54017,17 +54557,17 @@ paths:
description: Response
content:
application/json:
- schema: &377
+ schema: &380
type: object
properties:
number: *54
created_at: *55
- updated_at: *133
+ updated_at: *136
url: *56
html_url: *57
- instances_url: *369
- state: *138
- fixed_at: *134
+ instances_url: *372
+ state: *141
+ fixed_at: *137
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -54035,9 +54575,9 @@ paths:
properties: *20
required: *21
nullable: true
- dismissed_at: *135
- dismissed_reason: *370
- dismissed_comment: *371
+ dismissed_at: *138
+ dismissed_reason: *373
+ dismissed_comment: *374
rule:
type: object
properties:
@@ -54091,8 +54631,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *373
- most_recent_instance: *374
+ tool: *376
+ most_recent_instance: *377
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -54188,7 +54728,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54208,9 +54748,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
requestBody:
required: true
content:
@@ -54225,8 +54765,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *370
- dismissed_comment: *371
+ dismissed_reason: *373
+ dismissed_comment: *374
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -54245,7 +54785,7 @@ paths:
description: Response
content:
application/json:
- schema: *377
+ schema: *380
examples:
default:
value:
@@ -54321,7 +54861,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &381
+ '403': &384
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -54348,15 +54888,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
responses:
'200':
description: Response
content:
application/json:
- schema: &378
+ schema: &381
type: object
properties:
status:
@@ -54382,13 +54922,13 @@ paths:
- description
- started_at
examples:
- default: &379
+ default: &382
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &380
+ '400': &383
description: Bad Request
content:
application/json:
@@ -54399,7 +54939,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': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54424,29 +54964,29 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
responses:
'200':
description: OK
content:
application/json:
- schema: *378
+ schema: *381
examples:
- default: *379
+ default: *382
'202':
description: Accepted
content:
application/json:
- schema: *378
+ schema: *381
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *380
+ '400': *383
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -54478,9 +55018,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
requestBody:
required: false
content:
@@ -54525,8 +55065,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *380
- '403': *381
+ '400': *383
+ '403': *384
'404': *6
'422':
description: Unprocessable Entity
@@ -54550,13 +55090,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
- *19
- *17
- - *382
- - *383
+ - *385
+ - *386
responses:
'200':
description: Response
@@ -54564,7 +55104,7 @@ paths:
application/json:
schema:
type: array
- items: *374
+ items: *377
examples:
default:
value:
@@ -54603,7 +55143,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54637,25 +55177,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *276
- - *277
- - *364
- - *365
+ - *279
+ - *280
+ - *367
+ - *368
- *19
- *17
- - *383
+ - *386
- 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/<branch name>` or simply
`<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
required: false
- schema: *366
+ schema: *369
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &386
+ schema: &389
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -54676,23 +55216,23 @@ paths:
application/json:
schema:
type: array
- items: &387
+ items: &390
type: object
properties:
- ref: *366
- commit_sha: &395
+ ref: *369
+ commit_sha: &398
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: *384
+ analysis_key: *387
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *385
+ category: *388
error:
type: string
example: error reading field xyz
@@ -54716,8 +55256,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *386
- tool: *373
+ sarif_id: *389
+ tool: *376
deletable:
type: boolean
warning:
@@ -54778,7 +55318,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54814,8 +55354,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -54828,7 +55368,7 @@ paths:
description: Response
content:
application/json:
- schema: *387
+ schema: *390
examples:
response:
summary: application/json response
@@ -54882,7 +55422,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54964,8 +55504,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -55018,7 +55558,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': *381
+ '403': *384
'404': *6
'503': *65
x-github:
@@ -55040,8 +55580,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -55049,7 +55589,7 @@ paths:
application/json:
schema:
type: array
- items: &388
+ items: &391
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -55160,7 +55700,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': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -55189,8 +55729,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: language
in: path
description: The language of the CodeQL database.
@@ -55202,7 +55742,7 @@ paths:
description: Response
content:
application/json:
- schema: *388
+ schema: *391
examples:
default:
value:
@@ -55234,9 +55774,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': &424
+ '302': &427
description: Found
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -55258,8 +55798,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: language
in: path
description: The language of the CodeQL database.
@@ -55269,7 +55809,7 @@ paths:
responses:
'204':
description: Response
- '403': *381
+ '403': *384
'404': *6
'503': *65
x-github:
@@ -55297,8 +55837,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -55307,7 +55847,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &389
+ language: &392
type: string
description: The language targeted by the CodeQL query
enum:
@@ -55386,7 +55926,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &393
+ schema: &396
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -55396,7 +55936,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *53
actor: *4
- query_language: *389
+ query_language: *392
query_pack_url:
type: string
description: The download url for the query pack.
@@ -55443,7 +55983,7 @@ paths:
items:
type: object
properties:
- repository: &390
+ repository: &393
title: Repository Identifier
description: Repository Identifier
type: object
@@ -55479,7 +56019,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &394
+ analysis_status: &397
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -55511,7 +56051,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &391
+ access_mismatch_repos: &394
type: object
properties:
repository_count:
@@ -55525,7 +56065,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: *390
+ items: *393
required:
- repository_count
- repositories
@@ -55547,8 +56087,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *391
- over_limit_repos: *391
+ no_codeql_db_repos: *394
+ over_limit_repos: *394
required:
- access_mismatch_repos
- not_found_repos
@@ -55564,7 +56104,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &392
+ value: &395
summary: Default response
value:
id: 1
@@ -55716,10 +56256,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *392
+ value: *395
repository_lists:
summary: Response for a successful variant analysis submission
- value: *392
+ value: *395
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -55747,8 +56287,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -55760,9 +56300,9 @@ paths:
description: Response
content:
application/json:
- schema: *393
+ schema: *396
examples:
- default: *392
+ default: *395
'404': *6
'503': *65
x-github:
@@ -55785,7 +56325,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis
parameters:
- - *276
+ - *279
- name: repo
in: path
description: The name of the controller repository.
@@ -55820,7 +56360,7 @@ paths:
type: object
properties:
repository: *53
- analysis_status: *394
+ analysis_status: *397
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -55945,8 +56485,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -56020,7 +56560,7 @@ paths:
query_suite: default
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -56041,8 +56581,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -56124,7 +56664,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *381
+ '403': *384
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -56189,8 +56729,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -56198,7 +56738,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *395
+ commit_sha: *398
ref:
type: string
description: |-
@@ -56256,7 +56796,7 @@ paths:
schema:
type: object
properties:
- id: *386
+ id: *389
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -56270,7 +56810,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': *381
+ '403': *384
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -56293,8 +56833,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -56340,7 +56880,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': *375
+ '403': *378
'404':
description: Not Found if the sarif id does not match any upload
'503': *65
@@ -56365,8 +56905,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -56422,7 +56962,7 @@ paths:
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325
created_at: '2024-05-01T00:00:00Z'
updated_at: '2024-05-01T00:00:00Z'
- '204': *142
+ '204': *145
'304': *37
'403': *29
'404': *6
@@ -56447,8 +56987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -56568,8 +57108,8 @@ paths:
parameters:
- *17
- *19
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -56585,7 +57125,7 @@ paths:
type: integer
codespaces:
type: array
- items: *195
+ items: *198
examples:
default:
value:
@@ -56861,7 +57401,7 @@ paths:
start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start
stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop
recent_folders: []
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -56883,8 +57423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -56947,17 +57487,17 @@ paths:
description: Response when the codespace was successfully created
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'400': *14
'401': *25
'403': *29
@@ -56986,8 +57526,8 @@ paths:
parameters:
- *17
- *19
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -57027,7 +57567,7 @@ paths:
- path: ".devcontainer.json"
display_name: Default project configuration
total_count: 3
- '500': *145
+ '500': *148
'400': *14
'401': *25
'403': *29
@@ -57051,8 +57591,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -57087,14 +57627,14 @@ paths:
type: integer
machines:
type: array
- items: &610
+ items: &613
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *397
- required: *398
+ properties: *400
+ required: *401
examples:
- default: &611
+ default: &614
value:
total_count: 2
machines:
@@ -57111,7 +57651,7 @@ paths:
memory_in_bytes: 34359738368
cpus: 8
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -57134,8 +57674,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -57219,8 +57759,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -57286,8 +57826,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -57305,7 +57845,7 @@ paths:
type: integer
secrets:
type: array
- items: &402
+ items: &405
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -57325,7 +57865,7 @@ paths:
- created_at
- updated_at
examples:
- default: *399
+ default: *402
headers:
Link: *58
x-github:
@@ -57348,16 +57888,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *400
+ schema: *403
examples:
- default: *401
+ default: *404
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -57377,17 +57917,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *402
+ schema: *405
examples:
- default: *403
+ default: *406
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57407,8 +57947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
requestBody:
required: true
@@ -57461,8 +58001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'204':
@@ -57491,8 +58031,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -57534,7 +58074,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &404
+ properties: &407
login:
type: string
example: octocat
@@ -57627,7 +58167,7 @@ paths:
user_view_type:
type: string
example: public
- required: &405
+ required: &408
- avatar_url
- events_url
- followers_url
@@ -57701,8 +58241,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
responses:
'204':
@@ -57745,8 +58285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
requestBody:
required: false
@@ -57773,7 +58313,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &472
+ schema: &475
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -57995,8 +58535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
responses:
'204':
@@ -58026,8 +58566,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
responses:
'200':
@@ -58048,8 +58588,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *404
- required: *405
+ properties: *407
+ required: *408
nullable: true
required:
- permission
@@ -58104,8 +58644,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -58115,7 +58655,7 @@ paths:
application/json:
schema:
type: array
- items: &406
+ items: &409
title: Commit Comment
description: Commit Comment
type: object
@@ -58173,7 +58713,7 @@ paths:
- created_at
- updated_at
examples:
- default: &409
+ default: &412
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -58232,17 +58772,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'200':
description: Response
content:
application/json:
- schema: *406
+ schema: *409
examples:
- default: &410
+ default: &413
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -58299,8 +58839,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -58323,7 +58863,7 @@ paths:
description: Response
content:
application/json:
- schema: *406
+ schema: *409
examples:
default:
value:
@@ -58374,8 +58914,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'204':
@@ -58397,8 +58937,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -58425,9 +58965,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -58448,8 +58988,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -58482,16 +59022,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -58513,10 +59053,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- - *272
+ - *275
responses:
'204':
description: Response
@@ -58565,8 +59105,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -58622,9 +59162,9 @@ paths:
application/json:
schema:
type: array
- items: *407
+ items: *410
examples:
- default: &523
+ default: &526
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -58695,7 +59235,7 @@ paths:
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
headers:
Link: *58
- '500': *145
+ '500': *148
'400': *14
'404': *6
'409': *46
@@ -58718,9 +59258,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *276
- - *277
- - &408
+ - *279
+ - *280
+ - &411
name: commit_sha
description: The SHA of the commit.
in: path
@@ -58792,9 +59332,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
- *17
- *19
responses:
@@ -58804,9 +59344,9 @@ paths:
application/json:
schema:
type: array
- items: *406
+ items: *409
examples:
- default: *409
+ default: *412
headers:
Link: *58
x-github:
@@ -58834,9 +59374,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
requestBody:
required: true
content:
@@ -58871,9 +59411,9 @@ paths:
description: Response
content:
application/json:
- schema: *406
+ schema: *409
examples:
- default: *410
+ default: *413
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -58901,9 +59441,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
- *17
- *19
responses:
@@ -58913,7 +59453,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &517
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -59019,8 +59559,8 @@ paths:
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
nullable: true
active_lock_reason:
type: string
@@ -59065,7 +59605,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *188
+ items: *152
nullable: true
head:
type: object
@@ -59116,7 +59656,7 @@ paths:
_links:
type: object
properties:
- comments: &413
+ comments: &416
title: Link
description: Hypermedia Link
type: object
@@ -59125,13 +59665,13 @@ paths:
type: string
required:
- href
- commits: *413
- statuses: *413
- html: *413
- issue: *413
- review_comments: *413
- review_comment: *413
- self: *413
+ commits: *416
+ statuses: *416
+ html: *416
+ issue: *416
+ review_comments: *416
+ review_comment: *416
+ self: *416
required:
- comments
- commits
@@ -59142,7 +59682,7 @@ paths:
- review_comment
- self
author_association: *63
- auto_merge: &516
+ auto_merge: &519
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -59205,7 +59745,7 @@ paths:
- author_association
- auto_merge
examples:
- default: &515
+ default: &518
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -59742,11 +60282,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *19
- *17
- - &414
+ - &417
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)"
@@ -59761,9 +60301,9 @@ paths:
description: Response
content:
application/json:
- schema: *407
+ schema: *410
examples:
- default: &501
+ default: &504
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -59849,7 +60389,7 @@ paths:
.....
'422': *15
'404': *6
- '500': *145
+ '500': *148
'503': *65
'409': *46
x-github:
@@ -59876,11 +60416,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *276
- - *277
- - *414
- - *415
- - *416
+ - *279
+ - *280
+ - *417
+ - *418
+ - *419
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -59914,9 +60454,9 @@ paths:
type: integer
check_runs:
type: array
- items: *356
+ items: *359
examples:
- default: *417
+ default: *420
headers:
Link: *58
x-github:
@@ -59941,9 +60481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *276
- - *277
- - *414
+ - *279
+ - *280
+ - *417
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -59951,7 +60491,7 @@ paths:
schema:
type: integer
example: 1
- - *415
+ - *418
- *17
- *19
responses:
@@ -59969,7 +60509,7 @@ paths:
type: integer
check_suites:
type: array
- items: *361
+ items: *364
examples:
default:
value:
@@ -60169,9 +60709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *276
- - *277
- - *414
+ - *279
+ - *280
+ - *417
- *17
- *19
responses:
@@ -60369,9 +60909,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *276
- - *277
- - *414
+ - *279
+ - *280
+ - *417
- *17
- *19
responses:
@@ -60381,7 +60921,7 @@ paths:
application/json:
schema:
type: array
- items: &584
+ items: &587
title: Status
description: The status of a commit.
type: object
@@ -60462,7 +61002,7 @@ paths:
site_admin: false
headers:
Link: *58
- '301': *288
+ '301': *291
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60490,8 +61030,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -60520,20 +61060,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *418
- required: *419
+ properties: *421
+ required: *422
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &420
+ properties: &423
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &421
+ required: &424
- url
- html_url
nullable: true
@@ -60547,26 +61087,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
readme:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
required:
- code_of_conduct
@@ -60693,8 +61233,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *19
- *17
- name: basehead
@@ -60737,8 +61277,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *407
- merge_base_commit: *407
+ base_commit: *410
+ merge_base_commit: *410
status:
type: string
enum:
@@ -60758,10 +61298,10 @@ paths:
example: 6
commits:
type: array
- items: *407
+ items: *410
files:
type: array
- items: *422
+ items: *425
required:
- url
- html_url
@@ -61004,7 +61544,7 @@ paths:
patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@
module Test"
'404': *6
- '500': *145
+ '500': *148
'503': *65
x-github:
githubCloudOnly: false
@@ -61047,8 +61587,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: path
description: path parameter
in: path
@@ -61191,7 +61731,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &423
+ response-if-content-is-a-file: &426
summary: Response if content is a file
value:
type: file
@@ -61323,7 +61863,7 @@ paths:
- size
- type
- url
- - &528
+ - &531
title: Content File
description: Content File
type: object
@@ -61524,7 +62064,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *423
+ response-if-content-is-a-file: *426
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -61593,7 +62133,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *424
+ '302': *427
'304': *37
x-github:
githubCloudOnly: false
@@ -61616,8 +62156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: path
description: path parameter
in: path
@@ -61710,7 +62250,7 @@ paths:
description: Response
content:
application/json:
- schema: &425
+ schema: &428
title: File Commit
description: File Commit
type: object
@@ -61862,7 +62402,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *428
examples:
example-for-creating-a-file:
value:
@@ -61916,7 +62456,7 @@ paths:
schema:
oneOf:
- *3
- - &454
+ - &457
description: Repository rule violation was detected
type: object
properties:
@@ -61937,7 +62477,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &576
+ placeholder_id: &579
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -61969,8 +62509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: path
description: path parameter
in: path
@@ -62031,7 +62571,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *428
examples:
default:
value:
@@ -62086,8 +62626,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -62210,21 +62750,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *276
- - *277
- - *149
- - *150
- - *151
- - *152
+ - *279
+ - *280
+ - *153
+ - *154
+ - *155
+ - *156
- name: manifest
in: query
description: A comma-separated list of full manifest paths. If specified,
only alerts for these manifests will be returned.
schema:
type: string
- - *153
- - *154
- - *155
+ - *157
+ - *158
+ - *159
- *48
- name: page
description: "**Closing down notice**. Page number of the results to fetch.
@@ -62244,8 +62784,8 @@ paths:
default: 30
- *39
- *40
- - *156
- - *157
+ - *160
+ - *161
responses:
'200':
description: Response
@@ -62253,7 +62793,7 @@ paths:
application/json:
schema:
type: array
- items: &428
+ items: &431
type: object
description: A Dependabot alert.
properties:
@@ -62299,13 +62839,13 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *426
+ security_advisory: *429
security_vulnerability: *52
url: *56
html_url: *57
created_at: *55
- updated_at: *133
- dismissed_at: *135
+ updated_at: *136
+ dismissed_at: *138
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -62329,8 +62869,8 @@ paths:
dismissal.
nullable: true
maxLength: 280
- fixed_at: *134
- auto_dismissed_at: *427
+ fixed_at: *137
+ auto_dismissed_at: *430
required:
- number
- state
@@ -62560,9 +63100,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *276
- - *277
- - &429
+ - *279
+ - *280
+ - &432
name: alert_number
in: path
description: |-
@@ -62577,7 +63117,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *431
examples:
default:
value:
@@ -62690,9 +63230,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *276
- - *277
- - *429
+ - *279
+ - *280
+ - *432
requestBody:
required: true
content:
@@ -62737,7 +63277,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *431
examples:
default:
value:
@@ -62866,8 +63406,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -62885,7 +63425,7 @@ paths:
type: integer
secrets:
type: array
- items: &432
+ items: &435
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -62938,16 +63478,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *430
+ schema: *433
examples:
- default: *431
+ default: *434
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62967,15 +63507,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *432
+ schema: *435
examples:
default:
value:
@@ -63001,8 +63541,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
requestBody:
required: true
@@ -63055,8 +63595,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'204':
@@ -63079,8 +63619,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -63240,8 +63780,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -63480,8 +64020,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -63556,7 +64096,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &433
+ metadata: &436
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -63589,7 +64129,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *433
+ metadata: *436
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -63602,7 +64142,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *433
+ metadata: *436
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -63731,8 +64271,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -63772,9 +64312,9 @@ paths:
application/json:
schema:
type: array
- items: *434
+ items: *437
examples:
- default: *435
+ default: *438
headers:
Link: *58
x-github:
@@ -63840,8 +64380,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -63922,7 +64462,7 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *437
examples:
simple-example:
summary: Simple example
@@ -63995,9 +64535,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *276
- - *277
- - &436
+ - *279
+ - *280
+ - &439
name: deployment_id
description: deployment_id parameter
in: path
@@ -64009,7 +64549,7 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *437
examples:
default:
value:
@@ -64074,9 +64614,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
responses:
'204':
description: Response
@@ -64098,9 +64638,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
- *17
- *19
responses:
@@ -64110,7 +64650,7 @@ paths:
application/json:
schema:
type: array
- items: &437
+ items: &440
title: Deployment Status
description: The status of a deployment.
type: object
@@ -64271,9 +64811,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
requestBody:
required: true
content:
@@ -64348,9 +64888,9 @@ paths:
description: Response
content:
application/json:
- schema: *437
+ schema: *440
examples:
- default: &438
+ default: &441
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -64406,9 +64946,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
- name: status_id
in: path
required: true
@@ -64419,9 +64959,9 @@ paths:
description: Response
content:
application/json:
- schema: *437
+ schema: *440
examples:
- default: *438
+ default: *441
'404': *6
x-github:
githubCloudOnly: false
@@ -64446,8 +64986,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -64504,8 +65044,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -64522,7 +65062,7 @@ paths:
type: integer
environments:
type: array
- items: &440
+ items: &443
title: Environment
description: Details of a deployment environment
type: object
@@ -64574,7 +65114,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &442
+ wait_timer: &445
type: integer
example: 30
description: The amount of time to delay a job after
@@ -64611,11 +65151,11 @@ paths:
items:
type: object
properties:
- type: *439
+ type: *442
reviewer:
anyOf:
- *4
- - *188
+ - *152
required:
- id
- node_id
@@ -64635,7 +65175,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &443
+ deployment_branch_policy: &446
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -64751,9 +65291,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *276
- - *277
- - &441
+ - *279
+ - *280
+ - &444
name: environment_name
in: path
required: true
@@ -64766,9 +65306,9 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *443
examples:
- default: &444
+ default: &447
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -64852,9 +65392,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
requestBody:
required: false
content:
@@ -64863,7 +65403,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *442
+ wait_timer: *445
prevent_self_review:
type: boolean
example: false
@@ -64880,13 +65420,13 @@ paths:
items:
type: object
properties:
- type: *439
+ type: *442
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *443
+ deployment_branch_policy: *446
additionalProperties: false
examples:
default:
@@ -64906,9 +65446,9 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *443
examples:
- default: *444
+ default: *447
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -64932,9 +65472,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
responses:
'204':
description: Default response
@@ -64959,9 +65499,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *17
- *19
responses:
@@ -64979,7 +65519,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &445
+ items: &448
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -65036,9 +65576,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
requestBody:
required: true
content:
@@ -65084,9 +65624,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *448
examples:
- example-wildcard: &446
+ example-wildcard: &449
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -65128,10 +65668,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
- - &447
+ - *279
+ - *280
+ - *444
+ - &450
name: branch_policy_id
in: path
required: true
@@ -65143,9 +65683,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *448
examples:
- default: *446
+ default: *449
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65164,10 +65704,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
- - *447
+ - *279
+ - *280
+ - *444
+ - *450
requestBody:
required: true
content:
@@ -65195,9 +65735,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *448
examples:
- default: *446
+ default: *449
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65216,10 +65756,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
- - *447
+ - *279
+ - *280
+ - *444
+ - *450
responses:
'204':
description: Response
@@ -65244,9 +65784,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *441
- - *277
- - *276
+ - *444
+ - *280
+ - *279
responses:
'200':
description: List of deployment protection rules
@@ -65262,7 +65802,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &448
+ items: &451
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -65281,7 +65821,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &449
+ app: &452
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -65380,9 +65920,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *441
- - *277
- - *276
+ - *444
+ - *280
+ - *279
requestBody:
content:
application/json:
@@ -65403,9 +65943,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *448
+ schema: *451
examples:
- default: &450
+ default: &453
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -65440,9 +65980,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *441
- - *277
- - *276
+ - *444
+ - *280
+ - *279
- *19
- *17
responses:
@@ -65461,7 +66001,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *449
+ items: *452
examples:
default:
value:
@@ -65496,10 +66036,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *276
- - *277
- - *441
- - &451
+ - *279
+ - *280
+ - *444
+ - &454
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -65511,9 +66051,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *451
examples:
- default: *450
+ default: *453
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65534,10 +66074,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *441
- - *277
- - *276
- - *451
+ - *444
+ - *280
+ - *279
+ - *454
responses:
'204':
description: Response
@@ -65563,9 +66103,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *17
- *19
responses:
@@ -65583,9 +66123,9 @@ paths:
type: integer
secrets:
type: array
- items: *322
+ items: *325
examples:
- default: *323
+ default: *326
headers:
Link: *58
x-github:
@@ -65610,17 +66150,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
responses:
'200':
description: Response
content:
application/json:
- schema: *324
+ schema: *327
examples:
- default: *325
+ default: *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65642,18 +66182,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *322
+ schema: *325
examples:
- default: *452
+ default: *455
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65675,9 +66215,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *127
requestBody:
required: true
@@ -65735,9 +66275,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *127
responses:
'204':
@@ -65763,10 +66303,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *276
- - *277
- - *441
- - *298
+ - *279
+ - *280
+ - *444
+ - *301
- *19
responses:
'200':
@@ -65783,9 +66323,9 @@ paths:
type: integer
variables:
type: array
- items: *326
+ items: *329
examples:
- default: *327
+ default: *330
headers:
Link: *58
x-github:
@@ -65808,9 +66348,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
requestBody:
required: true
content:
@@ -65862,18 +66402,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *130
responses:
'200':
description: Response
content:
application/json:
- schema: *326
+ schema: *329
examples:
- default: *453
+ default: *456
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65894,10 +66434,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
- - *441
+ - *444
requestBody:
required: true
content:
@@ -65939,10 +66479,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
- - *441
+ - *444
responses:
'204':
description: Response
@@ -65964,8 +66504,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -66042,8 +66582,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -66202,8 +66742,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -66235,9 +66775,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
'400': *14
'422': *15
'403': *29
@@ -66258,8 +66798,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -66319,7 +66859,7 @@ paths:
schema:
oneOf:
- *97
- - *454
+ - *457
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66344,8 +66884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: file_sha
in: path
required: true
@@ -66444,8 +66984,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -66554,7 +67094,7 @@ paths:
description: Response
content:
application/json:
- schema: &455
+ schema: &458
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -66768,15 +67308,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
responses:
'200':
description: Response
content:
application/json:
- schema: *455
+ schema: *458
examples:
default:
value:
@@ -66832,9 +67372,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *276
- - *277
- - &456
+ - *279
+ - *280
+ - &459
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.
@@ -66851,7 +67391,7 @@ paths:
application/json:
schema:
type: array
- items: &457
+ items: &460
title: Git Reference
description: Git references within a repository
type: object
@@ -66926,17 +67466,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *276
- - *277
- - *456
+ - *279
+ - *280
+ - *459
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *460
examples:
- default: &458
+ default: &461
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -66965,8 +67505,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -66995,9 +67535,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *460
examples:
- default: *458
+ default: *461
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -67023,9 +67563,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *276
- - *277
- - *456
+ - *279
+ - *280
+ - *459
requestBody:
required: true
content:
@@ -67054,9 +67594,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *460
examples:
- default: *458
+ default: *461
'422': *15
'409': *46
x-github:
@@ -67074,9 +67614,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *276
- - *277
- - *456
+ - *279
+ - *280
+ - *459
responses:
'204':
description: Response
@@ -67129,8 +67669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -67197,7 +67737,7 @@ paths:
description: Response
content:
application/json:
- schema: &460
+ schema: &463
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -67248,7 +67788,7 @@ paths:
- sha
- type
- url
- verification: *459
+ verification: *462
required:
- sha
- url
@@ -67258,7 +67798,7 @@ paths:
- tag
- message
examples:
- default: &461
+ default: &464
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -67331,8 +67871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tag_sha
in: path
required: true
@@ -67343,9 +67883,9 @@ paths:
description: Response
content:
application/json:
- schema: *460
+ schema: *463
examples:
- default: *461
+ default: *464
'404': *6
'409': *46
x-github:
@@ -67369,8 +67909,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -67443,7 +67983,7 @@ paths:
description: Response
content:
application/json:
- schema: &462
+ schema: &465
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -67460,6 +68000,11 @@ paths:
type: array
items:
type: object
+ required:
+ - path
+ - mode
+ - type
+ - sha
properties:
path:
type: string
@@ -67486,29 +68031,8 @@ paths:
size: 30
sha: 44b4fc6d56897b048c772eb4087f854f46256132
url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132
- properties:
- path:
- type: string
- mode:
- type: string
- type:
- type: string
- size:
- type: integer
- sha:
- type: string
- url:
- type: string
- required:
- - path
- - mode
- - type
- - sha
- - url
- - size
required:
- sha
- - url
- tree
- truncated
examples:
@@ -67555,8 +68079,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -67579,7 +68103,7 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *465
examples:
default-response:
summary: Default response
@@ -67638,8 +68162,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -67649,7 +68173,7 @@ paths:
application/json:
schema:
type: array
- items: &463
+ items: &466
title: Webhook
description: Webhooks for repositories.
type: object
@@ -67703,7 +68227,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &687
+ last_response: &690
title: Hook Response
type: object
properties:
@@ -67777,8 +68301,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -67830,9 +68354,9 @@ paths:
description: Response
content:
application/json:
- schema: *463
+ schema: *466
examples:
- default: &464
+ default: &467
value:
type: Repository
id: 12345678
@@ -67880,17 +68404,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'200':
description: Response
content:
application/json:
- schema: *463
+ schema: *466
examples:
- default: *464
+ default: *467
'404': *6
x-github:
githubCloudOnly: false
@@ -67910,9 +68434,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
requestBody:
required: true
content:
@@ -67957,9 +68481,9 @@ paths:
description: Response
content:
application/json:
- schema: *463
+ schema: *466
examples:
- default: *464
+ default: *467
'422': *15
'404': *6
x-github:
@@ -67980,9 +68504,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'204':
description: Response
@@ -68006,9 +68530,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'200':
description: Response
@@ -68035,9 +68559,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
requestBody:
required: false
content:
@@ -68081,11 +68605,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
- *17
- - *166
+ - *170
responses:
'200':
description: Response
@@ -68093,9 +68617,9 @@ paths:
application/json:
schema:
type: array
- items: *167
+ items: *171
examples:
- default: *168
+ default: *172
'400': *14
'422': *15
x-github:
@@ -68114,18 +68638,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *169
+ schema: *173
examples:
- default: *170
+ default: *174
'400': *14
'422': *15
x-github:
@@ -68144,9 +68668,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
- *16
responses:
'202': *47
@@ -68169,9 +68693,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'204':
description: Response
@@ -68196,9 +68720,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'204':
description: Response
@@ -68256,14 +68780,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: &465
+ schema: &468
title: Import
description: A repository import from an external source.
type: object
@@ -68362,7 +68886,7 @@ paths:
- html_url
- authors_url
examples:
- default: &468
+ default: &471
value:
vcs: subversion
use_lfs: true
@@ -68378,7 +68902,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': &466
+ '503': &469
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -68407,8 +68931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -68456,7 +68980,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *468
examples:
default:
value:
@@ -68481,7 +69005,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68509,8 +69033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -68559,7 +69083,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *468
examples:
example-1:
summary: Example 1
@@ -68607,7 +69131,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': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68630,12 +69154,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68661,9 +69185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *276
- - *277
- - &634
+ - *279
+ - *280
+ - &637
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -68677,7 +69201,7 @@ paths:
application/json:
schema:
type: array
- items: &467
+ items: &470
title: Porter Author
description: Porter Author
type: object
@@ -68731,7 +69255,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': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68756,8 +69280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: author_id
in: path
required: true
@@ -68787,7 +69311,7 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *470
examples:
default:
value:
@@ -68800,7 +69324,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68824,8 +69348,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -68866,7 +69390,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68894,8 +69418,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -68922,11 +69446,11 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *468
examples:
- default: *468
+ default: *471
'422': *15
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68949,8 +69473,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -68958,8 +69482,8 @@ paths:
application/json:
schema: *22
examples:
- default: *469
- '301': *288
+ default: *472
+ '301': *291
'404': *6
x-github:
githubCloudOnly: false
@@ -68979,8 +69503,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -68988,12 +69512,12 @@ paths:
application/json:
schema:
anyOf:
- - *183
+ - *187
- type: object
properties: {}
additionalProperties: false
examples:
- default: &471
+ default: &474
value:
limit: collaborators_only
origin: repository
@@ -69018,13 +69542,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
application/json:
- schema: *470
+ schema: *473
examples:
default:
summary: Example request body
@@ -69036,9 +69560,9 @@ paths:
description: Response
content:
application/json:
- schema: *183
+ schema: *187
examples:
- default: *471
+ default: *474
'409':
description: Response
x-github:
@@ -69060,8 +69584,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -69084,8 +69608,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -69095,9 +69619,9 @@ paths:
application/json:
schema:
type: array
- items: *472
+ items: *475
examples:
- default: &627
+ default: &630
value:
- id: 1
repository:
@@ -69228,9 +69752,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *276
- - *277
- - *187
+ - *279
+ - *280
+ - *191
requestBody:
required: false
content:
@@ -69259,7 +69783,7 @@ paths:
description: Response
content:
application/json:
- schema: *472
+ schema: *475
examples:
default:
value:
@@ -69390,9 +69914,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *276
- - *277
- - *187
+ - *279
+ - *280
+ - *191
responses:
'204':
description: Response
@@ -69423,8 +69947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -69472,7 +69996,7 @@ paths:
required: false
schema:
type: string
- - *192
+ - *195
- name: sort
description: What to sort results by.
in: query
@@ -69497,7 +70021,7 @@ paths:
type: array
items: *77
examples:
- default: &483
+ default: &486
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -69645,7 +70169,7 @@ paths:
state_reason: completed
headers:
Link: *58
- '301': *288
+ '301': *291
'422': *15
'404': *6
x-github:
@@ -69674,8 +70198,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -69759,7 +70283,7 @@ paths:
application/json:
schema: *77
examples:
- default: &478
+ default: &481
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -69915,7 +70439,7 @@ paths:
'422': *15
'503': *65
'404': *6
- '410': *285
+ '410': *288
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -69943,8 +70467,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *87
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -69965,9 +70489,9 @@ paths:
application/json:
schema:
type: array
- items: *473
+ items: *476
examples:
- default: &480
+ default: &483
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -70025,17 +70549,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'200':
description: Response
content:
application/json:
- schema: *473
+ schema: *476
examples:
- default: &474
+ default: &477
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -70089,8 +70613,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -70113,9 +70637,9 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *476
examples:
- default: *474
+ default: *477
'422': *15
x-github:
githubCloudOnly: false
@@ -70133,8 +70657,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'204':
@@ -70155,8 +70679,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -70183,9 +70707,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -70206,8 +70730,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -70240,16 +70764,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -70271,10 +70795,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- - *272
+ - *275
responses:
'204':
description: Response
@@ -70294,8 +70818,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -70305,7 +70829,7 @@ paths:
application/json:
schema:
type: array
- items: &477
+ items: &480
title: Issue Event
description: Issue Event
type: object
@@ -70348,8 +70872,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *475
- required: *476
+ properties: *478
+ required: *479
nullable: true
label:
title: Issue Event Label
@@ -70393,7 +70917,7 @@ paths:
properties: *20
required: *21
nullable: true
- requested_team: *188
+ requested_team: *152
dismissed_review:
title: Issue Event Dismissed Review
type: object
@@ -70656,8 +71180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: event_id
in: path
required: true
@@ -70668,7 +71192,7 @@ paths:
description: Response
content:
application/json:
- schema: *477
+ schema: *480
examples:
default:
value:
@@ -70861,7 +71385,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *285
+ '410': *288
'403': *29
x-github:
githubCloudOnly: false
@@ -70895,9 +71419,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *276
- - *277
- - &479
+ - *279
+ - *280
+ - &482
name: issue_number
description: The number that identifies the issue.
in: path
@@ -70911,10 +71435,10 @@ paths:
application/json:
schema: *77
examples:
- default: *478
- '301': *288
+ default: *481
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
'304': *37
x-github:
githubCloudOnly: false
@@ -70939,9 +71463,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -71046,13 +71570,13 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
'422': *15
'503': *65
'403': *29
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71070,9 +71594,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -71100,7 +71624,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71116,9 +71640,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
content:
application/json:
@@ -71145,7 +71669,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71167,9 +71691,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- name: assignee
in: path
required: true
@@ -71209,9 +71733,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *67
- *17
- *19
@@ -71222,13 +71746,13 @@ paths:
application/json:
schema:
type: array
- items: *473
+ items: *476
examples:
- default: *480
+ default: *483
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71257,9 +71781,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -71281,16 +71805,16 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *476
examples:
- default: *474
+ default: *477
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *285
+ '410': *288
'422': *15
'404': *6
x-github:
@@ -71310,9 +71834,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -71326,7 +71850,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &484
+ - &487
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -71380,7 +71904,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &485
+ - &488
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -71516,7 +72040,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &486
+ - &489
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -71567,7 +72091,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &487
+ - &490
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -71618,7 +72142,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &488
+ - &491
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -71672,7 +72196,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &489
+ - &492
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -71706,7 +72230,7 @@ paths:
properties: *61
required: *62
review_requester: *4
- requested_team: *188
+ requested_team: *152
requested_reviewer: *4
required:
- review_requester
@@ -71719,7 +72243,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &490
+ - &493
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -71753,7 +72277,7 @@ paths:
properties: *61
required: *62
review_requester: *4
- requested_team: *188
+ requested_team: *152
requested_reviewer: *4
required:
- review_requester
@@ -71766,7 +72290,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &491
+ - &494
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -71826,7 +72350,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &492
+ - &495
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -71874,7 +72398,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &493
+ - &496
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -71940,7 +72464,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &494
+ - &497
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -72006,7 +72530,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &495
+ - &498
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -72072,7 +72596,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &496
+ - &499
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -72163,7 +72687,7 @@ paths:
color: red
headers:
Link: *58
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72180,9 +72704,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -72192,7 +72716,7 @@ paths:
application/json:
schema:
type: array
- items: &481
+ items: &484
title: Label
description: Color-coded labels help you categorize and filter your
issues (just like labels in Gmail).
@@ -72239,7 +72763,7 @@ paths:
- color
- default
examples:
- default: &482
+ default: &485
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -72257,9 +72781,9 @@ paths:
default: false
headers:
Link: *58
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72276,9 +72800,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -72337,12 +72861,12 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
- '301': *288
+ default: *485
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
'422': *15
x-github:
githubCloudOnly: false
@@ -72359,9 +72883,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -72421,12 +72945,12 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
- '301': *288
+ default: *485
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
'422': *15
x-github:
githubCloudOnly: false
@@ -72443,15 +72967,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
responses:
'204':
description: Response
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72470,9 +72994,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- name: name
in: path
required: true
@@ -72485,7 +73009,7 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
default:
value:
@@ -72496,9 +73020,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72518,9 +73042,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -72548,7 +73072,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *285
+ '410': *288
'404': *6
'422': *15
x-github:
@@ -72566,9 +73090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
responses:
'204':
description: Response
@@ -72590,9 +73114,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -72618,13 +73142,13 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72642,9 +73166,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72676,16 +73200,16 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -72707,10 +73231,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *276
- - *277
- - *479
- - *272
+ - *279
+ - *280
+ - *482
+ - *275
responses:
'204':
description: Response
@@ -72739,9 +73263,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72765,7 +73289,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -72798,9 +73322,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -72812,11 +73336,11 @@ paths:
type: array
items: *77
examples:
- default: *483
+ default: *486
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72844,9 +73368,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72875,14 +73399,14 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *285
+ '410': *288
'422': *15
'404': *6
x-github:
@@ -72902,9 +73426,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72937,7 +73461,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
'403': *29
'404': *6
'422': *7
@@ -72959,9 +73483,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -72976,9 +73500,6 @@ paths:
description: Timeline Event
type: object
anyOf:
- - *484
- - *485
- - *486
- *487
- *488
- *489
@@ -72989,6 +73510,9 @@ paths:
- *494
- *495
- *496
+ - *497
+ - *498
+ - *499
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -73293,7 +73817,7 @@ paths:
type: string
comments:
type: array
- items: &517
+ items: &520
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -73502,7 +74026,7 @@ paths:
type: string
comments:
type: array
- items: *406
+ items: *409
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -73791,7 +74315,7 @@ paths:
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73808,8 +74332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -73819,7 +74343,7 @@ paths:
application/json:
schema:
type: array
- items: &497
+ items: &500
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -73884,8 +74408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -73921,9 +74445,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *500
examples:
- default: &498
+ default: &501
value:
id: 1
key: ssh-rsa AAA...
@@ -73957,9 +74481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *276
- - *277
- - &499
+ - *279
+ - *280
+ - &502
name: key_id
description: The unique identifier of the key.
in: path
@@ -73971,9 +74495,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *500
examples:
- default: *498
+ default: *501
'404': *6
x-github:
githubCloudOnly: false
@@ -73991,9 +74515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *276
- - *277
- - *499
+ - *279
+ - *280
+ - *502
responses:
'204':
description: Response
@@ -74013,8 +74537,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -74024,9 +74548,9 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
+ default: *485
headers:
Link: *58
'404': *6
@@ -74047,8 +74571,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74084,9 +74608,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *484
examples:
- default: &500
+ default: &503
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -74118,8 +74642,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: name
in: path
required: true
@@ -74130,9 +74654,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *484
examples:
- default: *500
+ default: *503
'404': *6
x-github:
githubCloudOnly: false
@@ -74149,8 +74673,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: name
in: path
required: true
@@ -74189,7 +74713,7 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *484
examples:
default:
value:
@@ -74215,8 +74739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: name
in: path
required: true
@@ -74242,8 +74766,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -74282,9 +74806,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *276
- - *277
- - *382
+ - *279
+ - *280
+ - *385
responses:
'200':
description: Response
@@ -74429,8 +74953,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74495,8 +75019,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74530,9 +75054,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *407
+ schema: *410
examples:
- default: *501
+ default: *504
'204':
description: Response when already merged
'404':
@@ -74557,8 +75081,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -74599,12 +75123,12 @@ paths:
application/json:
schema:
type: array
- items: &502
+ items: &505
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
examples:
default:
value:
@@ -74660,8 +75184,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74701,9 +75225,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *505
examples:
- default: &503
+ default: &506
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -74762,9 +75286,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *276
- - *277
- - &504
+ - *279
+ - *280
+ - &507
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -74776,9 +75300,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *505
examples:
- default: *503
+ default: *506
'404': *6
x-github:
githubCloudOnly: false
@@ -74795,9 +75319,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *276
- - *277
- - *504
+ - *279
+ - *280
+ - *507
requestBody:
required: false
content:
@@ -74835,9 +75359,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *505
examples:
- default: *503
+ default: *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74853,9 +75377,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *276
- - *277
- - *504
+ - *279
+ - *280
+ - *507
responses:
'204':
description: Response
@@ -74876,9 +75400,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *276
- - *277
- - *504
+ - *279
+ - *280
+ - *507
- *17
- *19
responses:
@@ -74888,9 +75412,9 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
+ default: *485
headers:
Link: *58
x-github:
@@ -74909,12 +75433,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *276
- - *277
- - *505
- - *506
+ - *279
+ - *280
+ - *508
+ - *509
- *67
- - *507
+ - *510
- *17
- *19
responses:
@@ -74926,7 +75450,7 @@ paths:
type: array
items: *90
examples:
- default: *508
+ default: *511
headers:
Link: *58
x-github:
@@ -74950,8 +75474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -75009,14 +75533,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: &509
+ schema: &512
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -75141,7 +75665,7 @@ paths:
- custom_404
- public
examples:
- default: &510
+ default: &513
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -75182,8 +75706,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -75237,9 +75761,9 @@ paths:
description: Response
content:
application/json:
- schema: *509
+ schema: *512
examples:
- default: *510
+ default: *513
'422': *15
'409': *46
x-github:
@@ -75262,8 +75786,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -75362,8 +75886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -75389,8 +75913,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -75400,7 +75924,7 @@ paths:
application/json:
schema:
type: array
- items: &511
+ items: &514
title: Page Build
description: Page Build
type: object
@@ -75494,8 +76018,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'201':
description: Response
@@ -75540,16 +76064,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *514
examples:
- default: &512
+ default: &515
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -75597,8 +76121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: build_id
in: path
required: true
@@ -75609,9 +76133,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *514
examples:
- default: *512
+ default: *515
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75631,8 +76155,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -75737,9 +76261,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *276
- - *277
- - &513
+ - *279
+ - *280
+ - &516
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -75797,11 +76321,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *276
- - *277
- - *513
+ - *279
+ - *280
+ - *516
responses:
- '204': *142
+ '204': *145
'404': *6
x-github:
githubCloudOnly: false
@@ -75826,8 +76350,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -76085,8 +76609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Private vulnerability reporting status
@@ -76123,10 +76647,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
- '204': *142
+ '204': *145
'422': *14
x-github:
githubCloudOnly: false
@@ -76145,10 +76669,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
- '204': *142
+ '204': *145
'422': *14
x-github:
githubCloudOnly: false
@@ -76169,8 +76693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#list-repository-projects
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: state
description: Indicates the state of the projects to return.
in: query
@@ -76191,7 +76715,7 @@ paths:
application/json:
schema:
type: array
- items: *226
+ items: *229
examples:
default:
value:
@@ -76231,7 +76755,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '410': *285
+ '410': *288
'422': *7
x-github:
githubCloudOnly: false
@@ -76254,8 +76778,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#create-a-repository-project
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -76281,13 +76805,13 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
- default: *284
+ default: *287
'401': *25
'403': *29
'404': *6
- '410': *285
+ '410': *288
'422': *7
x-github:
githubCloudOnly: false
@@ -76310,8 +76834,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -76319,7 +76843,7 @@ paths:
application/json:
schema:
type: array
- items: *231
+ items: *234
examples:
default:
value:
@@ -76350,8 +76874,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -76363,7 +76887,7 @@ paths:
type: array
description: A list of custom property names and associated values
to apply to the repositories.
- items: *231
+ items: *234
required:
- properties
examples:
@@ -76413,8 +76937,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -76474,9 +76998,9 @@ paths:
application/json:
schema:
type: array
- items: *514
+ items: *517
examples:
- default: *515
+ default: *518
headers:
Link: *58
'304': *37
@@ -76508,8 +77032,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -76574,7 +77098,7 @@ paths:
description: Response
content:
application/json:
- schema: &519
+ schema: &522
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -76685,8 +77209,8 @@ paths:
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
nullable: true
active_lock_reason:
type: string
@@ -76731,7 +77255,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *254
+ items: *257
nullable: true
head:
type: object
@@ -76770,14 +77294,14 @@ paths:
_links:
type: object
properties:
- comments: *413
- commits: *413
- statuses: *413
- html: *413
- issue: *413
- review_comments: *413
- review_comment: *413
- self: *413
+ comments: *416
+ commits: *416
+ statuses: *416
+ html: *416
+ issue: *416
+ review_comments: *416
+ review_comment: *416
+ self: *416
required:
- comments
- commits
@@ -76788,7 +77312,7 @@ paths:
- review_comment
- self
author_association: *63
- auto_merge: *516
+ auto_merge: *519
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -76880,7 +77404,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &520
+ default: &523
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -77407,8 +77931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sort
in: query
required: false
@@ -77437,9 +77961,9 @@ paths:
application/json:
schema:
type: array
- items: *517
+ items: *520
examples:
- default: &522
+ default: &525
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -77516,17 +78040,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
- default: &518
+ default: &521
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -77601,8 +78125,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -77625,9 +78149,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
- default: *518
+ default: *521
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -77643,8 +78167,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'204':
@@ -77666,8 +78190,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -77694,9 +78218,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -77717,8 +78241,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -77751,16 +78275,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -77782,10 +78306,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- - *272
+ - *275
responses:
'204':
description: Response
@@ -77828,9 +78352,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *276
- - *277
- - &521
+ - *279
+ - *280
+ - &524
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -77843,9 +78367,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *519
+ schema: *522
examples:
- default: *520
+ default: *523
'304': *37
'404': *6
'406':
@@ -77853,7 +78377,7 @@ paths:
content:
application/json:
schema: *3
- '500': *145
+ '500': *148
'503': *65
x-github:
githubCloudOnly: false
@@ -77880,9 +78404,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -77924,9 +78448,9 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *522
examples:
- default: *520
+ default: *523
'422': *15
'403': *29
x-github:
@@ -77948,9 +78472,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: true
content:
@@ -78010,17 +78534,17 @@ paths:
description: Response when the codespace was successfully created
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'401': *25
'403': *29
'404': *6
@@ -78050,9 +78574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *87
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -78073,9 +78597,9 @@ paths:
application/json:
schema:
type: array
- items: *517
+ items: *520
examples:
- default: *522
+ default: *525
headers:
Link: *58
x-github:
@@ -78108,9 +78632,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: true
content:
@@ -78215,7 +78739,7 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
example-for-a-multi-line-comment:
value:
@@ -78303,9 +78827,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *76
requestBody:
required: true
@@ -78328,7 +78852,7 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
default:
value:
@@ -78414,9 +78938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *17
- *19
responses:
@@ -78426,9 +78950,9 @@ paths:
application/json:
schema:
type: array
- items: *407
+ items: *410
examples:
- default: *523
+ default: *526
headers:
Link: *58
x-github:
@@ -78458,9 +78982,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *17
- *19
responses:
@@ -78470,7 +78994,7 @@ paths:
application/json:
schema:
type: array
- items: *422
+ items: *425
examples:
default:
value:
@@ -78488,7 +79012,7 @@ paths:
headers:
Link: *58
'422': *15
- '500': *145
+ '500': *148
'503': *65
x-github:
githubCloudOnly: false
@@ -78508,9 +79032,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
responses:
'204':
description: Response if pull request has been merged
@@ -78533,9 +79057,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -78646,9 +79170,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
responses:
'200':
description: Response
@@ -78664,7 +79188,7 @@ paths:
items: *4
teams:
type: array
- items: *188
+ items: *152
required:
- users
- teams
@@ -78723,9 +79247,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -78762,7 +79286,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *517
examples:
default:
value:
@@ -79298,9 +79822,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: true
content:
@@ -79334,7 +79858,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *517
examples:
default:
value:
@@ -79839,9 +80363,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *17
- *19
responses:
@@ -79851,7 +80375,7 @@ paths:
application/json:
schema:
type: array
- items: &524
+ items: &527
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -80002,9 +80526,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -80090,9 +80614,9 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: &526
+ default: &529
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -80155,10 +80679,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - &525
+ - *279
+ - *280
+ - *524
+ - &528
name: review_id
description: The unique identifier of the review.
in: path
@@ -80170,9 +80694,9 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: &527
+ default: &530
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -80231,10 +80755,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
requestBody:
required: true
content:
@@ -80257,7 +80781,7 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
default:
value:
@@ -80319,18 +80843,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
responses:
'200':
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: *526
+ default: *529
'422': *7
'404': *6
x-github:
@@ -80357,10 +80881,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
- *17
- *19
responses:
@@ -80443,9 +80967,9 @@ paths:
_links:
type: object
properties:
- self: *413
- html: *413
- pull_request: *413
+ self: *416
+ html: *416
+ pull_request: *416
required:
- self
- html
@@ -80588,10 +81112,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
requestBody:
required: true
content:
@@ -80619,7 +81143,7 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
default:
value:
@@ -80682,10 +81206,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
requestBody:
required: true
content:
@@ -80720,9 +81244,9 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: *527
+ default: *530
'404': *6
'422': *7
'403': *29
@@ -80744,9 +81268,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -80809,8 +81333,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -80823,9 +81347,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *531
examples:
- default: &529
+ default: &532
value:
type: file
encoding: base64
@@ -80867,8 +81391,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: dir
description: The alternate path to look for a README file
in: path
@@ -80888,9 +81412,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *531
examples:
- default: *529
+ default: *532
'404': *6
'422': *15
x-github:
@@ -80912,8 +81436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -80923,7 +81447,7 @@ paths:
application/json:
schema:
type: array
- items: &530
+ items: &533
title: Release
description: A release.
type: object
@@ -80986,7 +81510,7 @@ paths:
author: *4
assets:
type: array
- items: &531
+ items: &534
title: Release Asset
description: Data related to a release.
type: object
@@ -81167,8 +81691,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -81244,9 +81768,9 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: &534
+ default: &537
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -81349,9 +81873,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *276
- - *277
- - &532
+ - *279
+ - *280
+ - &535
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -81363,9 +81887,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *534
examples:
- default: &533
+ default: &536
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
@@ -81399,7 +81923,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *424
+ '302': *427
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81415,9 +81939,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *276
- - *277
- - *532
+ - *279
+ - *280
+ - *535
requestBody:
required: false
content:
@@ -81445,9 +81969,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *534
examples:
- default: *533
+ default: *536
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81463,9 +81987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *276
- - *277
- - *532
+ - *279
+ - *280
+ - *535
responses:
'204':
description: Response
@@ -81489,8 +82013,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -81575,16 +82099,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81601,8 +82125,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tag
description: tag parameter
in: path
@@ -81615,9 +82139,9 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
'404': *6
x-github:
githubCloudOnly: false
@@ -81639,9 +82163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *276
- - *277
- - &535
+ - *279
+ - *280
+ - &538
name: release_id
description: The unique identifier of the release.
in: path
@@ -81655,9 +82179,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
'401':
description: Unauthorized
x-github:
@@ -81675,9 +82199,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
requestBody:
required: false
content:
@@ -81741,9 +82265,9 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -81764,9 +82288,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
responses:
'204':
description: Response
@@ -81786,9 +82310,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
- *17
- *19
responses:
@@ -81798,7 +82322,7 @@ paths:
application/json:
schema:
type: array
- items: *531
+ items: *534
examples:
default:
value:
@@ -81878,9 +82402,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:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
- name: name
in: query
required: true
@@ -81906,7 +82430,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *531
+ schema: *534
examples:
response-for-successful-upload:
value:
@@ -81960,9 +82484,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -81986,9 +82510,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -82009,9 +82533,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
requestBody:
required: true
content:
@@ -82041,16 +82565,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -82072,10 +82596,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *276
- - *277
- - *535
- - *272
+ - *279
+ - *280
+ - *538
+ - *275
responses:
'204':
description: Response
@@ -82099,9 +82623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
- *17
- *19
responses:
@@ -82117,8 +82641,8 @@ paths:
description: A repository rule with ruleset details.
oneOf:
- allOf:
- - *536
- - &538
+ - *539
+ - &541
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -82138,65 +82662,65 @@ paths:
type: integer
description: The ID of the ruleset that includes this rule.
- allOf:
- - *537
- - *538
- - allOf:
- - *539
- - *538
- - allOf:
- *540
- - *538
- - allOf:
- *541
- - *538
- allOf:
- *542
- - *538
+ - *541
- allOf:
- *543
- - *538
+ - *541
- allOf:
- *544
- - *538
+ - *541
- allOf:
- *545
- - *538
+ - *541
- allOf:
- *546
- - *538
+ - *541
- allOf:
- *547
- - *538
+ - *541
- allOf:
- *548
- - *538
+ - *541
- allOf:
- *549
- - *538
+ - *541
- allOf:
- *550
- - *538
+ - *541
- allOf:
- *551
- - *538
+ - *541
- allOf:
- *552
- - *538
+ - *541
- allOf:
- *553
- - *538
+ - *541
- allOf:
- *554
- - *538
+ - *541
- allOf:
- *555
- - *538
+ - *541
- allOf:
- *556
- - *538
+ - *541
- allOf:
- *557
- - *538
+ - *541
+ - allOf:
+ - *558
+ - *541
+ - allOf:
+ - *559
+ - *541
+ - allOf:
+ - *560
+ - *541
examples:
default:
value:
@@ -82235,8 +82759,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- name: includes_parents
@@ -82247,7 +82771,7 @@ paths:
schema:
type: boolean
default: true
- - *558
+ - *561
responses:
'200':
description: Response
@@ -82255,7 +82779,7 @@ paths:
application/json:
schema:
type: array
- items: *241
+ items: *244
examples:
default:
value:
@@ -82286,7 +82810,7 @@ paths:
created_at: '2023-08-15T08:43:03Z'
updated_at: '2023-09-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
post:
summary: Create a repository ruleset
description: Create a ruleset for a repository.
@@ -82302,8 +82826,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
description: Request body
required: true
@@ -82323,16 +82847,16 @@ paths:
- tag
- push
default: branch
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *235
+ items: *241
+ conditions: *238
rules:
type: array
description: An array of rules within the ruleset.
- items: *240
+ items: *243
required:
- name
- enforcement
@@ -82363,9 +82887,9 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: &568
+ default: &571
value:
id: 42
name: super cool ruleset
@@ -82398,7 +82922,7 @@ paths:
created_at: '2023-07-15T08:43:03Z'
updated_at: '2023-08-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
"/repos/{owner}/{repo}/rulesets/rule-suites":
get:
summary: List repository rule suites
@@ -82412,12 +82936,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *276
- - *277
- - *559
- - *560
- - *561
+ - *279
+ - *280
- *562
+ - *563
+ - *564
+ - *565
- *17
- *19
responses:
@@ -82425,11 +82949,11 @@ paths:
description: Response
content:
application/json:
- schema: *563
+ schema: *566
examples:
- default: *564
+ default: *567
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82448,19 +82972,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *276
- - *277
- - *565
+ - *279
+ - *280
+ - *568
responses:
'200':
description: Response
content:
application/json:
- schema: *566
+ schema: *569
examples:
- default: *567
+ default: *570
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82486,8 +83010,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82507,11 +83031,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *568
+ default: *571
'404': *6
- '500': *145
+ '500': *148
put:
summary: Update a repository ruleset
description: Update a ruleset for a repository.
@@ -82527,8 +83051,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82553,16 +83077,16 @@ paths:
- branch
- tag
- push
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *235
+ items: *241
+ conditions: *238
rules:
description: An array of rules within the ruleset.
type: array
- items: *240
+ items: *243
examples:
default:
value:
@@ -82590,11 +83114,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *568
+ default: *571
'404': *6
- '500': *145
+ '500': *148
delete:
summary: Delete a repository ruleset
description: Delete a ruleset for a repository.
@@ -82610,8 +83134,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82622,7 +83146,7 @@ paths:
'204':
description: Response
'404': *6
- '500': *145
+ '500': *148
"/repos/{owner}/{repo}/rulesets/{ruleset_id}/history":
get:
summary: Get repository ruleset history
@@ -82634,8 +83158,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- name: ruleset_id
@@ -82651,11 +83175,11 @@ paths:
application/json:
schema:
type: array
- items: *243
+ items: *246
examples:
- default: *569
+ default: *572
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82672,8 +83196,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82691,7 +83215,7 @@ paths:
description: Response
content:
application/json:
- schema: *570
+ schema: *573
examples:
default:
value:
@@ -82724,7 +83248,7 @@ paths:
operator: contains
pattern: github
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82746,20 +83270,20 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *276
- - *277
- - *244
- - *245
- - *246
+ - *279
+ - *280
- *247
- - *48
- - *19
- - *17
- - *571
- - *572
- *248
- *249
- *250
+ - *48
+ - *19
+ - *17
+ - *574
+ - *575
+ - *251
+ - *252
+ - *253
responses:
'200':
description: Response
@@ -82767,7 +83291,7 @@ paths:
application/json:
schema:
type: array
- items: &575
+ items: &578
type: object
properties:
number: *54
@@ -82786,8 +83310,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *573
- resolution: *574
+ state: *576
+ resolution: *577
resolved_at:
type: string
format: date-time
@@ -83005,15 +83529,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
responses:
'200':
description: Response
content:
application/json:
- schema: *575
+ schema: *578
examples:
default:
value:
@@ -83065,9 +83589,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
requestBody:
required: true
content:
@@ -83075,8 +83599,8 @@ paths:
schema:
type: object
properties:
- state: *573
- resolution: *574
+ state: *576
+ resolution: *577
resolution_comment:
description: An optional comment when closing an alert. Cannot be
updated or deleted. Must be `null` when changing `state` to `open`.
@@ -83094,7 +83618,7 @@ paths:
description: Response
content:
application/json:
- schema: *575
+ schema: *578
examples:
default:
value:
@@ -83169,9 +83693,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
- *19
- *17
responses:
@@ -83182,7 +83706,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &708
+ items: &711
type: object
properties:
type:
@@ -83541,8 +84065,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -83550,14 +84074,14 @@ paths:
schema:
type: object
properties:
- reason: &577
+ reason: &580
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *576
+ placeholder_id: *579
required:
- reason
- placeholder_id
@@ -83574,7 +84098,7 @@ paths:
schema:
type: object
properties:
- reason: *577
+ reason: *580
expire_at:
type: string
format: date-time
@@ -83617,8 +84141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -83633,7 +84157,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &578
+ items: &581
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -83659,15 +84183,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *578
+ items: *581
backfill_scans:
type: array
- items: *578
+ items: *581
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *578
+ - *581
- type: object
properties:
pattern_name:
@@ -83737,8 +84261,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *48
- name: sort
description: The property to sort the results by.
@@ -83782,9 +84306,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *582
examples:
- default: *580
+ default: *583
'400': *14
'404': *6
x-github:
@@ -83807,8 +84331,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -83881,7 +84405,7 @@ paths:
login:
type: string
description: The username of the user credited.
- type: *253
+ type: *256
required:
- login
- type
@@ -83968,9 +84492,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
- default: &582
+ default: &585
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -84203,8 +84727,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -84308,7 +84832,7 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
default:
value:
@@ -84455,17 +84979,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
responses:
'200':
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
- default: *582
+ default: *585
'403': *29
'404': *6
x-github:
@@ -84489,9 +85013,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
requestBody:
required: true
content:
@@ -84564,7 +85088,7 @@ paths:
login:
type: string
description: The username of the user credited.
- type: *253
+ type: *256
required:
- login
- type
@@ -84650,10 +85174,10 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
- default: *582
- add_credit: *582
+ default: *585
+ add_credit: *585
'403': *29
'404': *6
'422':
@@ -84691,9 +85215,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
responses:
'202': *47
'400': *14
@@ -84720,17 +85244,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
responses:
'202':
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
'400': *14
'422': *15
'403': *29
@@ -84756,8 +85280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -84856,8 +85380,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -84866,7 +85390,7 @@ paths:
application/json:
schema:
type: array
- items: &583
+ items: &586
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -84879,7 +85403,7 @@ paths:
- 1124
- -435
'202': *47
- '204': *142
+ '204': *145
'422':
description: Repository contains more than 10,000 commits
x-github:
@@ -84899,8 +85423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -84949,7 +85473,7 @@ paths:
total: 89
week: 1336280400
'202': *47
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84976,8 +85500,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -85051,7 +85575,7 @@ paths:
d: 77
c: 10
'202': *47
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85073,8 +85597,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -85228,8 +85752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -85239,7 +85763,7 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *586
examples:
default:
value:
@@ -85252,7 +85776,7 @@ paths:
- - 0
- 2
- 21
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85272,8 +85796,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sha
in: path
required: true
@@ -85327,7 +85851,7 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *587
examples:
default:
value:
@@ -85381,8 +85905,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -85394,7 +85918,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -85414,14 +85938,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &585
+ schema: &588
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -85489,8 +86013,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -85516,7 +86040,7 @@ paths:
description: Response
content:
application/json:
- schema: *585
+ schema: *588
examples:
default:
value:
@@ -85543,8 +86067,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -85564,8 +86088,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -85644,8 +86168,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -85653,7 +86177,7 @@ paths:
application/json:
schema:
type: array
- items: &586
+ items: &589
title: Tag protection
description: Tag protection
type: object
@@ -85705,8 +86229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -85729,7 +86253,7 @@ paths:
description: Response
content:
application/json:
- schema: *586
+ schema: *589
examples:
default:
value:
@@ -85760,8 +86284,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -85798,8 +86322,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
in: path
required: true
@@ -85835,8 +86359,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -85846,9 +86370,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
headers:
Link: *58
'404': *6
@@ -85868,8 +86392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *19
- *17
responses:
@@ -85877,7 +86401,7 @@ paths:
description: Response
content:
application/json:
- schema: &587
+ schema: &590
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -85889,7 +86413,7 @@ paths:
required:
- names
examples:
- default: &588
+ default: &591
value:
names:
- octocat
@@ -85912,8 +86436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -85944,9 +86468,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *590
examples:
- default: *588
+ default: *591
'404': *6
'422': *7
x-github:
@@ -85967,9 +86491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *276
- - *277
- - &589
+ - *279
+ - *280
+ - &592
name: per
description: The time frame to display results for.
in: query
@@ -85998,7 +86522,7 @@ paths:
example: 128
clones:
type: array
- items: &590
+ items: &593
title: Traffic
type: object
properties:
@@ -86085,8 +86609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -86176,8 +86700,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -86237,9 +86761,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *276
- - *277
- - *589
+ - *279
+ - *280
+ - *592
responses:
'200':
description: Response
@@ -86258,7 +86782,7 @@ paths:
example: 3782
views:
type: array
- items: *590
+ items: *593
required:
- uniques
- count
@@ -86335,8 +86859,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -86610,8 +87134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -86634,8 +87158,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -86657,8 +87181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -86684,8 +87208,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
in: path
required: true
@@ -86777,9 +87301,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -87027,7 +87551,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &591
+ text_matches: &594
title: Search Result Text Matches
type: array
items:
@@ -87189,7 +87713,7 @@ paths:
enum:
- author-date
- committer-date
- - &592
+ - &595
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
@@ -87260,7 +87784,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *342
+ properties: *345
nullable: true
comment_count:
type: integer
@@ -87280,7 +87804,7 @@ paths:
url:
type: string
format: uri
- verification: *459
+ verification: *462
required:
- author
- committer
@@ -87299,7 +87823,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *342
+ properties: *345
nullable: true
parents:
type: array
@@ -87317,7 +87841,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *591
+ text_matches: *594
required:
- sha
- node_id
@@ -87499,7 +88023,7 @@ paths:
- interactions
- created
- updated
- - *592
+ - *595
- *17
- *19
- name: advanced_search
@@ -87626,8 +88150,8 @@ paths:
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
nullable: true
comments:
type: integer
@@ -87641,7 +88165,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *591
+ text_matches: *594
pull_request:
type: object
properties:
@@ -87685,7 +88209,7 @@ paths:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
performed_via_github_app:
title: GitHub app
description: GitHub apps are a new way to extend GitHub.
@@ -87869,7 +88393,7 @@ paths:
enum:
- created
- updated
- - *592
+ - *595
- *17
- *19
responses:
@@ -87913,7 +88437,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *591
+ text_matches: *594
required:
- id
- node_id
@@ -87998,7 +88522,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *592
+ - *595
- *17
- *19
responses:
@@ -88237,7 +88761,7 @@ paths:
- admin
- pull
- push
- text_matches: *591
+ text_matches: *594
temp_clone_token:
type: string
allow_merge_commit:
@@ -88537,7 +89061,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *591
+ text_matches: *594
related:
type: array
nullable: true
@@ -88728,7 +89252,7 @@ paths:
- followers
- repositories
- joined
- - *592
+ - *595
- *17
- *19
responses:
@@ -88832,7 +89356,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *591
+ text_matches: *594
blog:
type: string
nullable: true
@@ -88911,7 +89435,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &593
+ - &596
name: team_id
description: The unique identifier of the team.
in: path
@@ -88923,9 +89447,9 @@ paths:
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
x-github:
githubCloudOnly: false
@@ -88952,7 +89476,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *593
+ - *596
requestBody:
required: true
content:
@@ -89015,16 +89539,16 @@ paths:
description: Response when the updated information already exists
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'201':
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
'422': *15
'403': *29
@@ -89052,7 +89576,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *593
+ - *596
responses:
'204':
description: Response
@@ -89083,7 +89607,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
parameters:
- - *593
+ - *596
- *48
- *17
- *19
@@ -89094,9 +89618,9 @@ paths:
application/json:
schema:
type: array
- items: *263
+ items: *266
examples:
- default: *594
+ default: *597
headers:
Link: *58
x-github:
@@ -89125,7 +89649,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *593
+ - *596
requestBody:
required: true
content:
@@ -89159,9 +89683,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *264
+ default: *267
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -89188,16 +89712,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
responses:
'200':
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *264
+ default: *267
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89222,8 +89746,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
requestBody:
required: false
content:
@@ -89246,9 +89770,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *595
+ default: *598
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89273,8 +89797,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
responses:
'204':
description: Response
@@ -89303,8 +89827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
- *48
- *17
- *19
@@ -89315,9 +89839,9 @@ paths:
application/json:
schema:
type: array
- items: *266
+ items: *269
examples:
- default: *596
+ default: *599
headers:
Link: *58
x-github:
@@ -89346,8 +89870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
requestBody:
required: true
content:
@@ -89369,9 +89893,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *267
+ default: *270
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -89398,17 +89922,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
responses:
'200':
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *267
+ default: *270
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89433,9 +89957,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
requestBody:
required: true
content:
@@ -89457,9 +89981,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *597
+ default: *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89484,9 +90008,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
responses:
'204':
description: Response
@@ -89515,9 +90039,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion comment.
@@ -89543,9 +90067,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
x-github:
@@ -89574,9 +90098,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
requestBody:
required: true
content:
@@ -89608,9 +90132,9 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89636,8 +90160,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion.
@@ -89663,9 +90187,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
x-github:
@@ -89694,8 +90218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
requestBody:
required: true
content:
@@ -89727,9 +90251,9 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -89753,7 +90277,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -89763,9 +90287,9 @@ paths:
application/json:
schema:
type: array
- items: *185
+ items: *189
examples:
- default: *186
+ default: *190
headers:
Link: *58
x-github:
@@ -89791,7 +90315,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *593
+ - *596
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -89814,7 +90338,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404': *6
@@ -89842,7 +90366,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -89879,7 +90403,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -89919,7 +90443,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -89956,16 +90480,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: *273
+ schema: *276
examples:
- response-if-user-is-a-team-maintainer: *598
+ response-if-user-is-a-team-maintainer: *601
'404': *6
x-github:
githubCloudOnly: false
@@ -89998,7 +90522,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *593
+ - *596
- *132
requestBody:
required: false
@@ -90024,9 +90548,9 @@ paths:
description: Response
content:
application/json:
- schema: *273
+ schema: *276
examples:
- response-if-users-membership-with-team-is-now-pending: *599
+ response-if-users-membership-with-team-is-now-pending: *602
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -90060,7 +90584,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -90089,7 +90613,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -90099,9 +90623,9 @@ paths:
application/json:
schema:
type: array
- items: *274
+ items: *277
examples:
- default: *600
+ default: *603
headers:
Link: *58
'404': *6
@@ -90127,16 +90651,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy
parameters:
- - *593
- - *275
+ - *596
+ - *278
responses:
'200':
description: Response
content:
application/json:
- schema: *274
+ schema: *277
examples:
- default: *601
+ default: *604
'404':
description: Not Found if project is not managed by this team
x-github:
@@ -90160,8 +90684,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- - *593
- - *275
+ - *596
+ - *278
requestBody:
required: false
content:
@@ -90228,8 +90752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy
parameters:
- - *593
- - *275
+ - *596
+ - *278
responses:
'204':
description: Response
@@ -90256,7 +90780,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -90268,7 +90792,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
'404': *6
@@ -90298,15 +90822,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *593
- - *276
- - *277
+ - *596
+ - *279
+ - *280
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *602
+ schema: *605
examples:
alternative-response-with-extra-repository-information:
value:
@@ -90457,9 +90981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *593
- - *276
- - *277
+ - *596
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -90509,9 +91033,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *593
- - *276
- - *277
+ - *596
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -90536,7 +91060,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -90546,9 +91070,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- response-if-child-teams-exist: *603
+ response-if-child-teams-exist: *606
headers:
Link: *58
'404': *6
@@ -90581,7 +91105,7 @@ paths:
application/json:
schema:
oneOf:
- - &605
+ - &608
title: Private User
description: Private User
type: object
@@ -90784,7 +91308,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *604
+ - *607
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -90937,7 +91461,7 @@ paths:
description: Response
content:
application/json:
- schema: *605
+ schema: *608
examples:
default:
value:
@@ -91016,7 +91540,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'304': *37
'404': *6
'403': *29
@@ -91140,11 +91664,11 @@ paths:
type: integer
codespaces:
type: array
- items: *195
+ items: *198
examples:
- default: *196
+ default: *199
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91281,17 +91805,17 @@ paths:
description: Response when the codespace was successfully created
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'401': *25
'403': *29
'404': *6
@@ -91335,7 +91859,7 @@ paths:
type: integer
secrets:
type: array
- items: &606
+ items: &609
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -91375,7 +91899,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *399
+ default: *402
headers:
Link: *58
x-github:
@@ -91451,7 +91975,7 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *609
examples:
default:
value:
@@ -91597,11 +92121,11 @@ paths:
type: array
items: *119
examples:
- default: *607
+ default: *610
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91654,7 +92178,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91688,7 +92212,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91721,7 +92245,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91741,17 +92265,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91775,7 +92299,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
requestBody:
required: false
content:
@@ -91805,9 +92329,9 @@ paths:
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'401': *25
'403': *29
'404': *6
@@ -91829,11 +92353,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'202': *47
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91858,13 +92382,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'202':
description: Response
content:
application/json:
- schema: &608
+ schema: &611
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -91905,7 +92429,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &609
+ default: &612
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -91913,7 +92437,7 @@ paths:
sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2
id: latest
export_url: https://api.github.com/user/codespaces/:name/exports/latest
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91937,7 +92461,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export
parameters:
- - *197
+ - *200
- name: export_id
in: path
required: true
@@ -91950,9 +92474,9 @@ paths:
description: Response
content:
application/json:
- schema: *608
+ schema: *611
examples:
- default: *609
+ default: *612
'404': *6
x-github:
githubCloudOnly: false
@@ -91973,7 +92497,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
@@ -91989,11 +92513,11 @@ paths:
type: integer
machines:
type: array
- items: *610
+ items: *613
examples:
- default: *611
+ default: *614
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -92020,7 +92544,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace
parameters:
- - *197
+ - *200
requestBody:
required: true
content:
@@ -92070,13 +92594,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *287
+ repository: *290
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *397
- required: *398
+ properties: *400
+ required: *401
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -92850,17 +93374,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'304': *37
- '500': *145
+ '500': *148
'400': *14
'401': *25
'402':
@@ -92890,16 +93414,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
- '500': *145
+ default: *399
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -92928,9 +93452,9 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: &624
+ default: &627
value:
- id: 197
name: hello_docker
@@ -93031,7 +93555,7 @@ paths:
application/json:
schema:
type: array
- items: &612
+ items: &615
title: Email
description: Email
type: object
@@ -93096,9 +93620,9 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *615
examples:
- default: &626
+ default: &629
value:
- email: octocat@github.com
verified: true
@@ -93173,7 +93697,7 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *615
examples:
default:
value:
@@ -93283,7 +93807,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'304': *37
@@ -93316,7 +93840,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'304': *37
@@ -93429,7 +93953,7 @@ paths:
application/json:
schema:
type: array
- items: &613
+ items: &616
title: GPG Key
description: A unique encryption key
type: object
@@ -93560,7 +94084,7 @@ paths:
- subkeys
- revoked
examples:
- default: &637
+ default: &640
value:
- id: 3
name: Octocat's GPG Key
@@ -93645,9 +94169,9 @@ paths:
description: Response
content:
application/json:
- schema: *613
+ schema: *616
examples:
- default: &614
+ default: &617
value:
id: 3
name: Octocat's GPG Key
@@ -93704,7 +94228,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &615
+ - &618
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -93716,9 +94240,9 @@ paths:
description: Response
content:
application/json:
- schema: *613
+ schema: *616
examples:
- default: *614
+ default: *617
'404': *6
'304': *37
'403': *29
@@ -93741,7 +94265,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *615
+ - *618
responses:
'204':
description: Response
@@ -93932,7 +94456,7 @@ paths:
type: array
items: *60
examples:
- default: *616
+ default: *619
headers:
Link: *58
'404': *6
@@ -94017,12 +94541,12 @@ paths:
application/json:
schema:
anyOf:
- - *183
+ - *187
- type: object
properties: {}
additionalProperties: false
examples:
- default: *184
+ default: *188
'204':
description: Response when there are no restrictions
x-github:
@@ -94046,7 +94570,7 @@ paths:
required: true
content:
application/json:
- schema: *470
+ schema: *473
examples:
default:
value:
@@ -94057,7 +94581,7 @@ paths:
description: Response
content:
application/json:
- schema: *183
+ schema: *187
examples:
default:
value:
@@ -94138,7 +94662,7 @@ paths:
- closed
- all
default: open
- - *192
+ - *195
- name: sort
description: What to sort results by.
in: query
@@ -94163,7 +94687,7 @@ paths:
type: array
items: *77
examples:
- default: *193
+ default: *196
headers:
Link: *58
'404': *6
@@ -94196,7 +94720,7 @@ paths:
application/json:
schema:
type: array
- items: &617
+ items: &620
title: Key
description: Key
type: object
@@ -94293,9 +94817,9 @@ paths:
description: Response
content:
application/json:
- schema: *617
+ schema: *620
examples:
- default: &618
+ default: &621
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -94328,15 +94852,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *499
+ - *502
responses:
'200':
description: Response
content:
application/json:
- schema: *617
+ schema: *620
examples:
- default: *618
+ default: *621
'404': *6
'304': *37
'403': *29
@@ -94359,7 +94883,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *499
+ - *502
responses:
'204':
description: Response
@@ -94392,7 +94916,7 @@ paths:
application/json:
schema:
type: array
- items: &619
+ items: &622
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -94460,7 +94984,7 @@ paths:
- account
- plan
examples:
- default: &620
+ default: &623
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -94522,9 +95046,9 @@ paths:
application/json:
schema:
type: array
- items: *619
+ items: *622
examples:
- default: *620
+ default: *623
headers:
Link: *58
'304': *37
@@ -94564,7 +95088,7 @@ paths:
application/json:
schema:
type: array
- items: *200
+ items: *203
examples:
default:
value:
@@ -94672,7 +95196,7 @@ paths:
description: Response
content:
application/json:
- schema: *200
+ schema: *203
examples:
default:
value:
@@ -94755,7 +95279,7 @@ paths:
description: Response
content:
application/json:
- schema: *200
+ schema: *203
examples:
default:
value:
@@ -94823,7 +95347,7 @@ paths:
application/json:
schema:
type: array
- items: *202
+ items: *205
examples:
default:
value:
@@ -95076,7 +95600,7 @@ paths:
description: Response
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -95256,7 +95780,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status
parameters:
- - *203
+ - *206
- name: exclude
in: query
required: false
@@ -95269,7 +95793,7 @@ paths:
description: Response
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -95463,7 +95987,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive
parameters:
- - *203
+ - *206
responses:
'302':
description: Response
@@ -95489,7 +96013,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive
parameters:
- - *203
+ - *206
responses:
'204':
description: Response
@@ -95518,8 +96042,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- - *203
- - *621
+ - *206
+ - *624
responses:
'204':
description: Response
@@ -95543,7 +96067,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration
parameters:
- - *203
+ - *206
- *17
- *19
responses:
@@ -95555,7 +96079,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
'404': *6
@@ -95590,9 +96114,9 @@ paths:
application/json:
schema:
type: array
- items: *199
+ items: *202
examples:
- default: *622
+ default: *625
headers:
Link: *58
'304': *37
@@ -95634,7 +96158,7 @@ paths:
- docker
- nuget
- container
- - *623
+ - *626
- *19
- *17
responses:
@@ -95644,10 +96168,10 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *624
- '400': *625
+ default: *627
+ '400': *628
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -95667,16 +96191,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
responses:
'200':
description: Response
content:
application/json:
- schema: *210
+ schema: *213
examples:
- default: &638
+ default: &641
value:
id: 40201
name: octo-name
@@ -95789,8 +96313,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
responses:
'204':
description: Response
@@ -95820,8 +96344,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- name: token
description: package token
schema:
@@ -95853,8 +96377,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *19
- *17
- name: state
@@ -95874,7 +96398,7 @@ paths:
application/json:
schema:
type: array
- items: *214
+ items: *217
examples:
default:
value:
@@ -95923,15 +96447,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
responses:
'200':
description: Response
content:
application/json:
- schema: *214
+ schema: *217
examples:
default:
value:
@@ -95967,9 +96491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
responses:
'204':
description: Response
@@ -95999,9 +96523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
responses:
'204':
description: Response
@@ -96057,7 +96581,7 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
default:
value:
@@ -96129,9 +96653,9 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *615
examples:
- default: *626
+ default: *629
headers:
Link: *58
'304': *37
@@ -96244,7 +96768,7 @@ paths:
type: array
items: *60
examples:
- default: &633
+ default: &636
summary: Default response
value:
- id: 1296269
@@ -96548,9 +97072,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -96588,9 +97112,9 @@ paths:
application/json:
schema:
type: array
- items: *472
+ items: *475
examples:
- default: *627
+ default: *630
headers:
Link: *58
'304': *37
@@ -96613,7 +97137,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation
parameters:
- - *187
+ - *191
responses:
'204':
description: Response
@@ -96636,7 +97160,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation
parameters:
- - *187
+ - *191
responses:
'204':
description: Response
@@ -96669,7 +97193,7 @@ paths:
application/json:
schema:
type: array
- items: &628
+ items: &631
title: Social account
description: Social media account
type: object
@@ -96684,7 +97208,7 @@ paths:
- provider
- url
examples:
- default: &629
+ default: &632
value:
- provider: twitter
url: https://twitter.com/github
@@ -96746,9 +97270,9 @@ paths:
application/json:
schema:
type: array
- items: *628
+ items: *631
examples:
- default: *629
+ default: *632
'422': *15
'304': *37
'404': *6
@@ -96835,7 +97359,7 @@ paths:
application/json:
schema:
type: array
- items: &630
+ items: &633
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -96855,7 +97379,7 @@ paths:
- title
- created_at
examples:
- default: &645
+ default: &648
value:
- key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -96921,9 +97445,9 @@ paths:
description: Response
content:
application/json:
- schema: *630
+ schema: *633
examples:
- default: &631
+ default: &634
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -96954,7 +97478,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:
- - &632
+ - &635
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -96966,9 +97490,9 @@ paths:
description: Response
content:
application/json:
- schema: *630
+ schema: *633
examples:
- default: *631
+ default: *634
'404': *6
'304': *37
'403': *29
@@ -96991,7 +97515,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:
- - *632
+ - *635
responses:
'204':
description: Response
@@ -97020,7 +97544,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &646
+ - &649
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
@@ -97045,11 +97569,11 @@ paths:
type: array
items: *60
examples:
- default-response: *633
+ default-response: *636
application/vnd.github.v3.star+json:
schema:
type: array
- items: &647
+ items: &650
title: Starred Repository
description: Starred Repository
type: object
@@ -97205,8 +97729,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response if this repository is starred by you
@@ -97234,8 +97758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -97259,8 +97783,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -97295,7 +97819,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
'304': *37
@@ -97332,7 +97856,7 @@ paths:
application/json:
schema:
type: array
- items: *261
+ items: *264
examples:
default:
value:
@@ -97418,10 +97942,10 @@ paths:
application/json:
schema:
oneOf:
- - *605
- - *604
+ - *608
+ - *607
examples:
- default-response: &635
+ default-response: &638
summary: Default response
value:
login: octocat
@@ -97456,7 +97980,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &636
+ response-with-git-hub-plan-information: &639
summary: Response with GitHub plan information
value:
login: octocat
@@ -97516,7 +98040,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *634
+ - *637
- *17
responses:
'200':
@@ -97527,7 +98051,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link:
example: <https://api.github.com/users?since=135>; rel="next"
@@ -97565,11 +98089,11 @@ paths:
application/json:
schema:
oneOf:
- - *605
- - *604
+ - *608
+ - *607
examples:
- default-response: *635
- response-with-git-hub-plan-information: *636
+ default-response: *638
+ response-with-git-hub-plan-information: *639
'404': *6
x-github:
githubCloudOnly: false
@@ -97645,7 +98169,7 @@ paths:
bundle_url:
type: string
examples:
- default: *338
+ default: *341
'201':
description: Response
content:
@@ -97684,9 +98208,9 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *624
+ default: *627
'403': *29
'401': *25
x-github:
@@ -97969,7 +98493,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -98000,7 +98524,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -98090,9 +98614,9 @@ paths:
application/json:
schema:
type: array
- items: *613
+ items: *616
examples:
- default: *637
+ default: *640
headers:
Link: *58
x-github:
@@ -98196,7 +98720,7 @@ paths:
application/json:
schema: *22
examples:
- default: *469
+ default: *472
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98272,9 +98796,9 @@ paths:
application/json:
schema:
type: array
- items: *199
+ items: *202
examples:
- default: *622
+ default: *625
headers:
Link: *58
x-github:
@@ -98313,7 +98837,7 @@ paths:
- docker
- nuget
- container
- - *623
+ - *626
- *132
- *19
- *17
@@ -98324,12 +98848,12 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *624
+ default: *627
'403': *29
'401': *25
- '400': *625
+ '400': *628
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98349,17 +98873,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: *210
+ schema: *213
examples:
- default: *638
+ default: *641
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98380,8 +98904,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
responses:
'204':
@@ -98414,8 +98938,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
- name: token
description: package token
@@ -98448,8 +98972,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
responses:
'200':
@@ -98458,7 +98982,7 @@ paths:
application/json:
schema:
type: array
- items: *214
+ items: *217
examples:
default:
value:
@@ -98516,16 +99040,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: *214
+ schema: *217
examples:
default:
value:
@@ -98560,10 +99084,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user
parameters:
- - *212
- - *213
- - *132
- *215
+ - *216
+ - *132
+ - *218
responses:
'204':
description: Response
@@ -98595,10 +99119,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user
parameters:
- - *212
- - *213
- - *132
- *215
+ - *216
+ - *132
+ - *218
responses:
'204':
description: Response
@@ -98645,7 +99169,7 @@ paths:
application/json:
schema:
type: array
- items: *226
+ items: *229
examples:
default:
value:
@@ -98928,7 +99452,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -98958,9 +99482,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *642
examples:
- default: *640
+ default: *643
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98988,9 +99512,9 @@ paths:
description: Response
content:
application/json:
- schema: *641
+ schema: *644
examples:
- default: *642
+ default: *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -99018,9 +99542,9 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *646
examples:
- default: *644
+ default: *647
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -99048,9 +99572,9 @@ paths:
application/json:
schema:
type: array
- items: *628
+ items: *631
examples:
- default: *629
+ default: *632
headers:
Link: *58
x-github:
@@ -99080,9 +99604,9 @@ paths:
application/json:
schema:
type: array
- items: *630
+ items: *633
examples:
- default: *645
+ default: *648
headers:
Link: *58
x-github:
@@ -99107,7 +99631,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *132
- - *646
+ - *649
- *48
- *17
- *19
@@ -99119,11 +99643,11 @@ paths:
schema:
anyOf:
- type: array
- items: *647
+ items: *650
- type: array
items: *60
examples:
- default-response: *633
+ default-response: *636
headers:
Link: *58
x-github:
@@ -99154,7 +99678,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -99282,7 +99806,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &648
+ enterprise: &651
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -99340,7 +99864,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &649
+ installation: &652
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -99359,7 +99883,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &650
+ organization: &653
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -99419,13 +99943,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &651
+ repository: &654
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: &681
+ properties: &684
id:
description: Unique identifier of the repository
example: 42
@@ -100108,7 +100632,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &682
+ required: &685
- archive_url
- assignees_url
- blobs_url
@@ -100259,10 +100783,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -100338,11 +100862,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- rule: &652
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ rule: &655
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)
@@ -100565,11 +101089,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- rule: *652
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ rule: *655
sender: *4
required:
- action
@@ -100752,11 +101276,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- rule: *652
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ rule: *655
sender: *4
required:
- action
@@ -100840,7 +101364,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &654
+ check_run: &657
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -100903,7 +101427,7 @@ x-webhooks:
type: string
pull_requests:
type: array
- items: *355
+ items: *358
repository: *119
status:
example: completed
@@ -100941,7 +101465,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *653
+ deployment: *656
details_url:
example: https://example.com
type: string
@@ -100991,7 +101515,7 @@ x-webhooks:
- annotations_url
pull_requests:
type: array
- items: *355
+ items: *358
started_at:
example: '2018-05-04T01:14:52Z'
type: string
@@ -101026,9 +101550,9 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- check_run
@@ -101421,10 +101945,10 @@ x-webhooks:
type: string
enum:
- created
- check_run: *654
- installation: *649
- organization: *650
- repository: *651
+ check_run: *657
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- check_run
@@ -101820,10 +102344,10 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *654
- installation: *649
- organization: *650
- repository: *651
+ check_run: *657
+ installation: *652
+ organization: *653
+ repository: *654
requested_action:
description: The action requested by the user.
type: object
@@ -102228,10 +102752,10 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *654
- installation: *649
- organization: *650
- repository: *651
+ check_run: *657
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- check_run
@@ -103208,10 +103732,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -103881,10 +104405,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -104548,10 +105072,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -104714,7 +105238,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -104859,20 +105383,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &655
+ commit_oid: &658
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: *648
- installation: *649
- organization: *650
- ref: &656
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: &659
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: *651
+ repository: *654
sender: *4
required:
- action
@@ -105034,7 +105558,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -105264,12 +105788,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -105364,7 +105888,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -105532,12 +106056,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -105700,7 +106224,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -105866,12 +106390,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -105968,7 +106492,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -106136,16 +106660,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
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: *651
+ repository: *654
sender: *4
required:
- action
@@ -106239,7 +106763,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -106379,12 +106903,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -106641,10 +107165,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -106724,18 +107248,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *650
- pusher_type: &657
+ organization: *653
+ pusher_type: &660
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &658
+ ref: &661
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -106745,7 +107269,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *651
+ repository: *654
sender: *4
required:
- ref
@@ -106827,10 +107351,10 @@ x-webhooks:
type: string
enum:
- created
- definition: *227
- enterprise: *648
- installation: *649
- organization: *650
+ definition: *230
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -106915,9 +107439,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -106994,10 +107518,10 @@ x-webhooks:
type: string
enum:
- promote_to_enterprise
- definition: *227
- enterprise: *648
- installation: *649
- organization: *650
+ definition: *230
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -107074,10 +107598,10 @@ x-webhooks:
type: string
enum:
- updated
- definition: *227
- enterprise: *648
- installation: *649
- organization: *650
+ definition: *230
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -107154,19 +107678,19 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- repository: *651
- organization: *650
+ enterprise: *651
+ installation: *652
+ repository: *654
+ organization: *653
sender: *4
new_property_values:
type: array
description: The new custom property values for the repository.
- items: *231
+ items: *234
old_property_values:
type: array
description: The old custom property values for the repository.
- items: *231
+ items: *234
required:
- action
- repository
@@ -107242,18 +107766,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- pusher_type: *657
- ref: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ pusher_type: *660
+ ref: *661
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *651
+ repository: *654
sender: *4
required:
- ref
@@ -107337,11 +107861,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107425,11 +107949,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107513,11 +108037,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107599,11 +108123,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107685,11 +108209,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107772,11 +108296,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107858,11 +108382,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107939,9 +108463,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- key: &659
+ enterprise: *651
+ installation: *652
+ key: &662
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -107977,8 +108501,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -108055,11 +108579,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- key: *659
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ key: *662
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -108620,12 +109144,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: &663
+ workflow: &666
title: Workflow
type: object
nullable: true
@@ -109351,13 +109875,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *434
+ deployment: *437
pull_requests:
type: array
- items: *519
- repository: *651
- organization: *650
- installation: *649
+ items: *522
+ repository: *654
+ organization: *653
+ installation: *652
sender: *4
responses:
'200':
@@ -109428,7 +109952,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &660
+ approver: &663
type: object
properties:
avatar_url:
@@ -109471,11 +109995,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- reviewers: &661
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ reviewers: &664
type: array
items:
type: object
@@ -109554,7 +110078,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &662
+ workflow_job_run: &665
type: object
properties:
conclusion:
@@ -110285,18 +110809,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *660
+ approver: *663
comment:
type: string
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- reviewers: *661
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ reviewers: *664
sender: *4
since:
type: string
- workflow_job_run: *662
+ workflow_job_run: *665
workflow_job_runs:
type: array
items:
@@ -111000,13 +111524,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *648
+ enterprise: *651
environment:
type: string
- installation: *649
- organization: *650
- repository: *651
- requestor: &668
+ installation: *652
+ organization: *653
+ repository: *654
+ requestor: &671
title: User
type: object
nullable: true
@@ -112905,12 +113429,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Deployment Workflow Run
type: object
@@ -113590,7 +114114,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &666
+ answer: &669
type: object
properties:
author_association:
@@ -113747,7 +114271,7 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: &664
+ discussion: &667
title: Discussion
description: A Discussion in a repository.
type: object
@@ -114033,7 +114557,7 @@ x-webhooks:
- id
labels:
type: array
- items: *481
+ items: *484
required:
- repository_url
- category
@@ -114055,10 +114579,10 @@ x-webhooks:
- author_association
- active_lock_reason
- body
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114185,11 +114709,11 @@ x-webhooks:
- from
required:
- category
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114272,11 +114796,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114358,7 +114882,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &665
+ comment: &668
type: object
properties:
author_association:
@@ -114515,11 +115039,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114602,12 +115126,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *665
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ comment: *668
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114702,12 +115226,12 @@ x-webhooks:
- from
required:
- body
- comment: *665
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ comment: *668
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114791,11 +115315,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114877,11 +115401,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114981,11 +115505,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115067,10 +115591,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *664
- enterprise: *648
- installation: *649
- label: &667
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ label: &670
title: Label
type: object
properties:
@@ -115102,8 +115626,8 @@ x-webhooks:
- color
- default
- description
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115186,11 +115710,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115272,11 +115796,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115358,11 +115882,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115447,16 +115971,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *664
- new_repository: *651
+ new_discussion: *667
+ new_repository: *654
required:
- new_discussion
- new_repository
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115539,10 +116063,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *664
- old_answer: *666
- organization: *650
- repository: *651
+ discussion: *667
+ old_answer: *669
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115624,12 +116148,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *664
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115712,11 +116236,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115798,11 +116322,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115875,7 +116399,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *648
+ enterprise: *651
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -116535,9 +117059,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- forkee
@@ -116683,9 +117207,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pages:
description: The pages that were updated.
type: array
@@ -116722,7 +117246,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *651
+ repository: *654
sender: *4
required:
- pages
@@ -116798,10 +117322,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: &669
+ organization: *653
+ repositories: &672
description: An array of repository objects that the installation
can access.
type: array
@@ -116827,8 +117351,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *651
- requester: *668
+ repository: *654
+ requester: *671
sender: *4
required:
- action
@@ -116903,11 +117427,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -116983,11 +117507,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -117063,10 +117587,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories_added: &670
+ organization: *653
+ repositories_added: &673
description: An array of repository objects, which were added to
the installation.
type: array
@@ -117112,15 +117636,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *651
- repository_selection: &671
+ repository: *654
+ repository_selection: &674
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *668
+ requester: *671
sender: *4
required:
- action
@@ -117199,10 +117723,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories_added: *670
+ organization: *653
+ repositories_added: *673
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -117229,9 +117753,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *651
- repository_selection: *671
- requester: *668
+ repository: *654
+ repository_selection: *674
+ requester: *671
sender: *4
required:
- action
@@ -117310,11 +117834,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -117492,10 +118016,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
target_type:
type: string
@@ -117574,11 +118098,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -117830,8 +118354,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -118654,7 +119178,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -118987,8 +119511,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -119068,7 +119592,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &672
+ comment: &675
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -119233,8 +119757,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -120053,7 +120577,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -120388,8 +120912,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -120469,7 +120993,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &700
+ changes: &703
description: The changes to the comment.
type: object
properties:
@@ -120481,9 +121005,9 @@ x-webhooks:
type: string
required:
- from
- comment: *672
- enterprise: *648
- installation: *649
+ comment: *675
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -121305,7 +121829,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -121638,8 +122162,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -121721,10 +122245,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *668
- enterprise: *648
- installation: *649
- issue: &675
+ assignee: *671
+ enterprise: *651
+ installation: *652
+ issue: &678
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -122542,7 +123066,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -122643,8 +123167,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -122724,8 +123248,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -123548,7 +124072,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -123784,8 +124308,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -123864,8 +124388,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -124677,7 +125201,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -124777,8 +125301,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -124857,8 +125381,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -125694,7 +126218,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -125773,7 +126297,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &673
+ milestone: &676
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -125911,8 +126435,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -126011,8 +126535,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -126827,7 +127351,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
title:
description: Title of the issue
type: string
@@ -126931,9 +127455,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *667
- organization: *650
- repository: *651
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -127013,8 +127537,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -127828,7 +128352,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
title:
description: Title of the issue
type: string
@@ -127932,9 +128456,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *667
- organization: *650
- repository: *651
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -128014,8 +128538,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -128853,7 +129377,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
title:
description: Title of the issue
type: string
@@ -128934,8 +129458,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -129014,8 +129538,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -129850,7 +130374,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -129928,9 +130452,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *673
- organization: *650
- repository: *651
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -131391,8 +131915,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -132210,7 +132734,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -132310,8 +132834,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -132391,9 +132915,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *648
- installation: *649
- issue: &674
+ enterprise: *651
+ installation: *652
+ issue: &677
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -133205,7 +133729,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -133305,8 +133829,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -133385,8 +133909,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -134303,9 +134827,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- type: *189
- organization: *650
- repository: *651
+ type: *192
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -135200,7 +135724,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -135768,11 +136292,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *648
- installation: *649
- issue: *674
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *677
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -135852,12 +136376,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *648
- installation: *649
- issue: *675
- type: *189
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ type: *192
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -135938,7 +136462,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &703
+ assignee: &706
title: User
type: object
nullable: true
@@ -136008,11 +136532,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *648
- installation: *649
- issue: *675
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -136091,12 +136615,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *648
- installation: *649
- issue: *675
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -136176,8 +136700,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -137016,7 +137540,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -137094,8 +137618,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137175,11 +137699,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *648
- installation: *649
- issue: *674
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *677
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137258,12 +137782,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *648
- installation: *649
- issue: *675
- type: *189
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ type: *192
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137343,11 +137867,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137425,11 +137949,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137539,11 +138063,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137625,9 +138149,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: &676
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: &679
title: Marketplace Purchase
type: object
required:
@@ -137710,8 +138234,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *650
- previous_marketplace_purchase: &677
+ organization: *653
+ previous_marketplace_purchase: &680
title: Marketplace Purchase
type: object
properties:
@@ -137791,7 +138315,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -137871,10 +138395,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: *676
- organization: *650
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: *679
+ organization: *653
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -137957,7 +138481,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -138039,10 +138563,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: *676
- organization: *650
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: *679
+ organization: *653
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -138124,7 +138648,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -138205,8 +138729,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -138288,9 +138812,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *650
- previous_marketplace_purchase: *677
- repository: *651
+ organization: *653
+ previous_marketplace_purchase: *680
+ repository: *654
sender: *4
required:
- action
@@ -138370,12 +138894,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: *676
- organization: *650
- previous_marketplace_purchase: *677
- repository: *651
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: *679
+ organization: *653
+ previous_marketplace_purchase: *680
+ repository: *654
sender: *4
required:
- action
@@ -138477,11 +139001,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -138581,11 +139105,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -138664,11 +139188,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -138746,11 +139270,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -138826,7 +139350,7 @@ x-webhooks:
required:
- login
- id
- team: &678
+ team: &681
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -139016,11 +139540,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -139097,7 +139621,7 @@ x-webhooks:
required:
- login
- id
- team: *678
+ team: *681
required:
- action
- scope
@@ -139179,8 +139703,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *649
- merge_group: &680
+ installation: *652
+ merge_group: &683
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -139199,15 +139723,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *679
+ head_commit: *682
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139293,10 +139817,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *649
- merge_group: *680
- organization: *650
- repository: *651
+ installation: *652
+ merge_group: *683
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139369,7 +139893,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
+ enterprise: *651
hook:
description: 'The modified webhook. This will contain different
keys based on the type of webhook it is: repository, organization,
@@ -139477,16 +140001,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *649
- organization: *650
+ installation: *652
+ organization: *653
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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -139567,11 +140091,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
- milestone: *673
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139650,9 +140174,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- milestone: &683
+ enterprise: *651
+ installation: *652
+ milestone: &686
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -139789,8 +140313,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139869,11 +140393,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- milestone: *673
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139983,11 +140507,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- milestone: *673
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140067,11 +140591,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *648
- installation: *649
- milestone: *683
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *686
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140150,11 +140674,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *668
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ blocked_user: *671
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140233,11 +140757,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *668
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ blocked_user: *671
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140316,9 +140840,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- membership: &684
+ enterprise: *651
+ installation: *652
+ membership: &687
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -140410,8 +140934,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140489,11 +141013,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *648
- installation: *649
- membership: *684
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ membership: *687
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140572,8 +141096,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -140689,10 +141213,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
- user: *668
+ user: *671
required:
- action
- invitation
@@ -140770,11 +141294,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *648
- installation: *649
- membership: *684
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ membership: *687
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140861,11 +141385,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *648
- installation: *649
- membership: *684
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ membership: *687
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140941,9 +141465,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
package:
description: Information about the package.
type: object
@@ -141442,7 +141966,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &685
+ items: &688
title: Ruby Gems metadata
type: object
properties:
@@ -141537,7 +142061,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -141613,9 +142137,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
package:
description: Information about the package.
type: object
@@ -141968,7 +142492,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *685
+ items: *688
source_url:
type: string
format: uri
@@ -142038,7 +142562,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -142215,12 +142739,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *648
+ enterprise: *651
id:
type: integer
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- id
@@ -142297,7 +142821,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &686
+ personal_access_token_request: &689
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -142443,10 +142967,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *648
- organization: *650
+ enterprise: *651
+ organization: *653
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142523,11 +143047,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *686
- enterprise: *648
- organization: *650
+ personal_access_token_request: *689
+ enterprise: *651
+ organization: *653
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142603,11 +143127,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *686
- enterprise: *648
- organization: *650
+ personal_access_token_request: *689
+ enterprise: *651
+ organization: *653
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142682,11 +143206,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *686
- organization: *650
- enterprise: *648
+ personal_access_token_request: *689
+ organization: *653
+ enterprise: *651
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142791,7 +143315,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *687
+ last_response: *690
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -142823,8 +143347,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
zen:
description: Random string of GitHub zen.
@@ -143069,10 +143593,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *648
- installation: *649
- organization: *650
- project_card: &688
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_card: &691
title: Project Card
type: object
properties:
@@ -143191,7 +143715,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -143272,11 +143796,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- project_card: *688
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_card: *691
+ repository: *654
sender: *4
required:
- action
@@ -143356,9 +143880,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
project_card:
title: Project Card
type: object
@@ -143486,8 +144010,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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -143581,11 +144105,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *648
- installation: *649
- organization: *650
- project_card: *688
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_card: *691
+ repository: *654
sender: *4
required:
- action
@@ -143679,9 +144203,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
project_card:
allOf:
- title: Project Card
@@ -143871,7 +144395,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -143951,10 +144475,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
- organization: *650
- project: &690
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: &693
title: Project
type: object
properties:
@@ -144078,7 +144602,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -144158,10 +144682,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- project_column: &689
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: &692
title: Project Column
type: object
properties:
@@ -144200,7 +144724,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -144279,18 +144803,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- project_column: *689
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: *692
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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -144380,11 +144904,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- project_column: *689
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: *692
+ repository: *654
sender: *4
required:
- action
@@ -144464,11 +144988,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *648
- installation: *649
- organization: *650
- project_column: *689
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: *692
+ repository: *654
sender: *4
required:
- action
@@ -144548,11 +145072,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
+ repository: *654
sender: *4
required:
- action
@@ -144632,18 +145156,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -144745,11 +145269,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
+ repository: *654
sender: *4
required:
- action
@@ -144828,11 +145352,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
+ repository: *654
sender: *4
required:
- action
@@ -144913,9 +145437,9 @@ x-webhooks:
type: string
enum:
- closed
- installation: *649
- organization: *650
- projects_v2: &691
+ installation: *652
+ organization: *653
+ projects_v2: &694
title: Projects v2 Project
description: A projects v2 project
type: object
@@ -145058,9 +145582,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -145141,9 +145665,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -145260,9 +145784,9 @@ x-webhooks:
type: string
to:
type: string
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -145345,7 +145869,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &695
+ changes: &698
type: object
properties:
archived_at:
@@ -145359,9 +145883,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *649
- organization: *650
- projects_v2_item: &692
+ installation: *652
+ organization: *653
+ projects_v2_item: &695
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -145495,9 +146019,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145579,9 +146103,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145662,9 +146186,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145770,7 +146294,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &693
+ - &696
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -145788,7 +146312,7 @@ x-webhooks:
required:
- id
- name
- - &694
+ - &697
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -145811,8 +146335,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *693
- - *694
+ - *696
+ - *697
required:
- field_value
- type: object
@@ -145828,9 +146352,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145925,9 +146449,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -146010,10 +146534,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *695
- installation: *649
- organization: *650
- projects_v2_item: *692
+ changes: *698
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -146095,9 +146619,9 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -146178,9 +146702,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *649
- organization: *650
- projects_v2_status_update: &696
+ installation: *652
+ organization: *653
+ projects_v2_status_update: &699
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
@@ -146307,9 +146831,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *649
- organization: *650
- projects_v2_status_update: *696
+ installation: *652
+ organization: *653
+ projects_v2_status_update: *699
sender: *4
required:
- action
@@ -146445,9 +146969,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *649
- organization: *650
- projects_v2_status_update: *696
+ installation: *652
+ organization: *653
+ projects_v2_status_update: *699
sender: *4
required:
- action
@@ -146518,10 +147042,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- repository
@@ -146598,13 +147122,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *668
- enterprise: *648
- installation: *649
- number: &697
+ assignee: *671
+ enterprise: *651
+ installation: *652
+ number: &700
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -148887,7 +149411,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -148969,11 +149493,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -151251,7 +151775,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -151333,11 +151857,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -153615,7 +154139,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -153697,13 +154221,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: &698
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: &701
allOf:
- - *519
+ - *522
- type: object
properties:
allow_auto_merge:
@@ -153765,7 +154289,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -153846,12 +154370,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -153931,11 +154455,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *648
- milestone: *502
- number: *697
- organization: *650
- pull_request: &699
+ enterprise: *651
+ milestone: *505
+ number: *700
+ organization: *653
+ pull_request: &702
title: Pull Request
type: object
properties:
@@ -156198,7 +156722,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -156277,11 +156801,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -158563,7 +159087,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -158687,12 +159211,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -158772,11 +159296,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -161043,7 +161567,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -161123,11 +161647,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *648
- installation: *649
- label: *667
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ label: *670
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -163409,7 +163933,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -163490,10 +164014,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -165773,7 +166297,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -165853,12 +166377,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *648
- milestone: *502
- number: *697
- organization: *650
- pull_request: *699
- repository: *651
+ enterprise: *651
+ milestone: *505
+ number: *700
+ organization: *653
+ pull_request: *702
+ repository: *654
sender: *4
required:
- action
@@ -165937,12 +166461,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -166023,12 +166547,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -166108,12 +166632,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -166479,9 +167003,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
type: object
properties:
@@ -168651,7 +169175,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -168731,7 +169255,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &701
+ comment: &704
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -169016,9 +169540,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
type: object
properties:
@@ -171176,7 +171700,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -171256,11 +171780,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *700
- comment: *701
- enterprise: *648
- installation: *649
- organization: *650
+ changes: *703
+ comment: *704
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
type: object
properties:
@@ -173421,7 +173945,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -173502,9 +174026,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -175677,7 +176201,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
+ repository: *654
review:
description: The review that was affected.
type: object
@@ -175920,9 +176444,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -177976,8 +178500,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
- review: &702
+ repository: *654
+ review: &705
description: The review that was affected.
type: object
properties:
@@ -178206,12 +178730,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -180494,7 +181018,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_reviewer:
title: User
type: object
@@ -180578,12 +181102,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -182873,7 +183397,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -183065,12 +183589,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -185355,7 +185879,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_reviewer:
title: User
type: object
@@ -185440,12 +185964,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -187721,7 +188245,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -187902,9 +188426,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -190079,8 +190603,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
- review: *702
+ repository: *654
+ review: *705
sender: *4
required:
- action
@@ -190160,9 +190684,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -192232,7 +192756,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
thread:
type: object
@@ -192615,9 +193139,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -194673,7 +195197,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
thread:
type: object
@@ -195059,10 +195583,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -197333,7 +197857,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -197415,11 +197939,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *703
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ assignee: *706
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -199702,7 +200226,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -199781,11 +200305,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *648
- installation: *649
- label: *667
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ label: *670
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -202058,7 +202582,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -202139,10 +202663,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -204407,7 +204931,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -204607,7 +205131,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *648
+ enterprise: *651
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -204699,8 +205223,8 @@ x-webhooks:
- url
- author
- committer
- installation: *649
- organization: *650
+ installation: *652
+ organization: *653
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -205275,9 +205799,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
registry_package:
type: object
properties:
@@ -205723,7 +206247,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *685
+ items: *688
summary:
type: string
tag_name:
@@ -205777,7 +206301,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -205855,9 +206379,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
registry_package:
type: object
properties:
@@ -206165,7 +206689,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *685
+ items: *688
summary:
type: string
tag_name:
@@ -206214,7 +206738,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -206291,10 +206815,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- release: &704
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: &707
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -206599,7 +207123,7 @@ x-webhooks:
- tarball_url
- zipball_url
- body
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -206676,11 +207200,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- release: *704
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *707
+ repository: *654
sender: *4
required:
- action
@@ -206797,11 +207321,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *648
- installation: *649
- organization: *650
- release: *704
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *707
+ repository: *654
sender: *4
required:
- action
@@ -206879,9 +207403,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -207190,7 +207714,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -207266,10 +207790,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
- release: &705
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: &708
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -207575,7 +208099,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -207651,11 +208175,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *648
- installation: *649
- organization: *650
- release: *704
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *707
+ repository: *654
sender: *4
required:
- action
@@ -207731,11 +208255,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *648
- installation: *649
- organization: *650
- release: *705
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *708
+ repository: *654
sender: *4
required:
- action
@@ -207811,11 +208335,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_advisory: *579
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_advisory: *582
sender: *4
required:
- action
@@ -207891,11 +208415,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_advisory: *579
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_advisory: *582
sender: *4
required:
- action
@@ -207971,10 +208495,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208051,10 +208575,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208132,10 +208656,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208219,10 +208743,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208334,10 +208858,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208409,10 +208933,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
status:
type: string
@@ -208493,10 +209017,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208573,10 +209097,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208670,10 +209194,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208753,11 +209277,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_ruleset: *241
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_ruleset: *244
sender: *4
required:
- action
@@ -208835,11 +209359,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_ruleset: *241
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_ruleset: *244
sender: *4
required:
- action
@@ -208917,11 +209441,11 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_ruleset: *241
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_ruleset: *244
changes:
type: object
properties:
@@ -208940,16 +209464,16 @@ x-webhooks:
properties:
added:
type: array
- items: *235
+ items: *238
deleted:
type: array
- items: *235
+ items: *238
updated:
type: array
items:
type: object
properties:
- condition: *235
+ condition: *238
changes:
type: object
properties:
@@ -208982,16 +209506,16 @@ x-webhooks:
properties:
added:
type: array
- items: *240
+ items: *243
deleted:
type: array
- items: *240
+ items: *243
updated:
type: array
items:
type: object
properties:
- rule: *240
+ rule: *243
changes:
type: object
properties:
@@ -209225,10 +209749,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209306,10 +209830,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209387,7 +209911,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &706
+ alert: &709
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -209508,10 +210032,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209717,10 +210241,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209798,11 +210322,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *706
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *709
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210001,10 +210525,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210082,7 +210606,7 @@ x-webhooks:
type: string
enum:
- created
- alert: &707
+ alert: &710
type: object
properties:
number: *54
@@ -210193,10 +210717,10 @@ x-webhooks:
description: Whether the detected secret was found in multiple
repositories in the same organization or business.
nullable: true
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210277,11 +210801,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *707
- installation: *649
- location: *708
- organization: *650
- repository: *651
+ alert: *710
+ installation: *652
+ location: *711
+ organization: *653
+ repository: *654
sender: *4
required:
- location
@@ -210519,11 +211043,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210601,11 +211125,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210683,11 +211207,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210765,11 +211289,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210895,10 +211419,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *651
- enterprise: *648
- installation: *649
- organization: *650
+ repository: *654
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -210976,11 +211500,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- security_advisory: &709
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ security_advisory: &712
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -211163,11 +211687,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- security_advisory: *709
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ security_advisory: *712
sender: *4
required:
- action
@@ -211240,10 +211764,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -211427,11 +211951,11 @@ x-webhooks:
from:
type: object
properties:
- security_and_analysis: *234
- enterprise: *648
- installation: *649
- organization: *650
- repository: *287
+ security_and_analysis: *237
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *290
sender: *4
required:
- changes
@@ -211509,12 +212033,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: &710
+ sponsorship: &713
type: object
properties:
created_at:
@@ -211815,12 +212339,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- sponsorship
@@ -211908,12 +212432,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- changes
@@ -211990,17 +212514,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &711
+ effective_date: &714
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: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- sponsorship
@@ -212074,7 +212598,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &712
+ changes: &715
type: object
properties:
tier:
@@ -212118,13 +212642,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *711
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ effective_date: *714
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- changes
@@ -212201,13 +212725,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *712
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ changes: *715
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- changes
@@ -212281,10 +212805,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -212367,10 +212891,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -212790,15 +213314,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *648
+ enterprise: *651
id:
description: The unique identifier of the status.
type: integer
- installation: *649
+ installation: *652
name:
type: string
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
sha:
description: The Commit SHA.
@@ -212913,9 +213437,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213005,9 +213529,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213097,9 +213621,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213189,9 +213713,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213268,12 +213792,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- team: &713
+ team: &716
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -213463,9 +213987,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -213923,7 +214447,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -213999,9 +214523,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -214459,7 +214983,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -214536,9 +215060,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -214996,7 +215520,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -215140,9 +215664,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -215600,7 +216124,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- changes
@@ -215678,9 +216202,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -216138,7 +216662,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -216214,10 +216738,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -216290,16 +216814,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *648
+ enterprise: *651
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *649
- organization: *650
+ installation: *652
+ organization: *653
ref:
type: string
- repository: *651
+ repository: *654
sender: *4
workflow:
type: string
@@ -216381,10 +216905,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
allOf:
@@ -216621,7 +217145,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -216700,10 +217224,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
allOf:
@@ -216963,7 +217487,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -217042,10 +217566,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
type: object
@@ -217180,7 +217704,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -217259,10 +217783,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
type: object
@@ -217398,7 +217922,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -217478,12 +218002,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Workflow Run
type: object
@@ -218482,12 +219006,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Workflow Run
type: object
@@ -219471,12 +219995,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
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 1c7ab9a91..f14ec9647 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json
+++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json
@@ -179,6 +179,10 @@
{
"name": "hosted-compute",
"description": "Manage hosted compute networking resources."
+ },
+ {
+ "name": "campaigns",
+ "description": "Endpoints to manage campaigns via the REST API."
}
],
"servers": [
@@ -65118,6 +65122,2631 @@
}
}
},
+ "/orgs/{org}/campaigns": {
+ "get": {
+ "summary": "List campaigns for an organization",
+ "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/list-org-campaigns",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "direction",
+ "description": "The direction to sort the results by.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "state",
+ "description": "If specified, only campaigns with this state will be returned.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ }
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "ends_at",
+ "published"
+ ],
+ "default": "created"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ },
+ {
+ "number": 4,
+ "created_at": "2024-03-30T12:29:18Z",
+ "updated_at": "2024-03-30T12:29:18Z",
+ "name": "Mitre top 10 KEV",
+ "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "ends_at": "2024-04-30T12:29:18Z",
+ "closed_at": null,
+ "state": "open"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "post": {
+ "summary": "Create a campaign for an organization",
+ "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/create-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The login of each manager",
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign. The date must be in the future.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "code_scanning_alerts": {
+ "description": "The code scanning alerts to include in this campaign",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "repository_id": {
+ "type": "integer",
+ "description": "The repository id"
+ },
+ "alert_numbers": {
+ "type": "array",
+ "description": "The alert numbers",
+ "minItems": 1,
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "repository_id",
+ "alert_numbers"
+ ]
+ }
+ },
+ "generate_issues": {
+ "description": "If true, will automatically generate issues for the campaign. The default is false.",
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "ends_at",
+ "code_scanning_alerts"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ "octocat"
+ ],
+ "ends_at": "2024-03-14T00:00:00Z",
+ "code_scanning_alerts": [
+ {
+ "repository_id": 1296269,
+ "alert_numbers": [
+ 1,
+ 2
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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": "Unprocessable Entity",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too Many Requests"
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
+ "/orgs/{org}/campaigns/{campaign_number}": {
+ "get": {
+ "summary": "Get a campaign for an organization",
+ "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/get-campaign-summary",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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": "Unprocessable Entity",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "patch": {
+ "summary": "Update a campaign",
+ "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/update-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "description": "A description for the campaign",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "managers": {
+ "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "type": "string"
+ }
+ },
+ "team_managers": {
+ "description": "The slugs of the teams to set as the campaign managers.",
+ "type": "array",
+ "maxItems": 10,
+ "items": {
+ "description": "The slug of each team",
+ "type": "string"
+ }
+ },
+ "ends_at": {
+ "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign. Must be a URI.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Critical CodeQL alerts"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Campaign summary",
+ "description": "The campaign metadata and alert stats.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of the newly created campaign"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+ },
+ "name": {
+ "type": "string",
+ "description": "The campaign name"
+ },
+ "description": {
+ "type": "string",
+ "description": "The campaign description"
+ },
+ "managers": {
+ "description": "The campaign managers",
+ "type": "array",
+ "items": {
+ "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"
+ ]
+ }
+ },
+ "team_managers": {
+ "description": "The campaign team managers",
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "example": "Justice League"
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "published_at": {
+ "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "ends_at": {
+ "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closed_at": {
+ "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.",
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "state": {
+ "title": "Campaign state",
+ "description": "Indicates whether a campaign is open or closed",
+ "type": "string",
+ "enum": [
+ "open",
+ "closed"
+ ]
+ },
+ "contact_link": {
+ "description": "The contact link of the campaign.",
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "alert_stats": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "open_count": {
+ "type": "integer",
+ "description": "The number of open alerts"
+ },
+ "closed_count": {
+ "type": "integer",
+ "description": "The number of closed alerts"
+ },
+ "in_progress_count": {
+ "type": "integer",
+ "description": "The number of in-progress alerts"
+ }
+ },
+ "required": [
+ "open_count",
+ "closed_count",
+ "in_progress_count"
+ ]
+ }
+ },
+ "required": [
+ "number",
+ "created_at",
+ "updated_at",
+ "description",
+ "managers",
+ "ends_at",
+ "state",
+ "contact_link"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "number": 3,
+ "created_at": "2024-02-14T12:29:18Z",
+ "updated_at": "2024-02-14T12:29:18Z",
+ "name": "Critical CodeQL alert",
+ "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.",
+ "managers": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "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
+ }
+ ],
+ "published_at": "2024-02-14T12:29:18Z",
+ "ends_at": "2024-03-14T12:29:18Z",
+ "closed_at": null,
+ "state": "open",
+ "alert_stats": {
+ "open_count": 10,
+ "closed_count": 3,
+ "in_progress_count": 3
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "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": "Unprocessable Entity",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ },
+ "delete": {
+ "summary": "Delete a campaign for an organization",
+ "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.",
+ "tags": [
+ "campaigns"
+ ],
+ "operationId": "campaigns/delete-campaign",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "campaign_number",
+ "description": "The campaign number.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Deletion successful"
+ },
+ "404": {
+ "description": "Resource not found",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "campaigns",
+ "subcategory": "campaigns"
+ }
+ }
+ },
"/orgs/{org}/code-scanning/alerts": {
"get": {
"summary": "List code scanning alerts for an organization",
@@ -124402,7 +127031,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -125684,7 +128313,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -126973,7 +129602,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -128903,7 +131532,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -130210,7 +132839,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -131495,7 +134124,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -281292,6 +283921,12 @@
"type": "array",
"items": {
"type": "object",
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha"
+ ],
"properties": {
"path": {
"type": "string",
@@ -281326,42 +283961,13 @@
"type": "blob",
"size": 30,
"sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "path",
- "mode",
- "type",
- "sha",
- "url",
- "size"
- ]
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
}
]
}
},
"required": [
"sha",
- "url",
"tree",
"truncated"
]
@@ -281628,6 +284234,12 @@
"type": "array",
"items": {
"type": "object",
+ "required": [
+ "path",
+ "mode",
+ "type",
+ "sha"
+ ],
"properties": {
"path": {
"type": "string",
@@ -281662,42 +284274,13 @@
"type": "blob",
"size": 30,
"sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "path",
- "mode",
- "type",
- "sha",
- "url",
- "size"
- ]
+ "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
}
]
}
},
"required": [
"sha",
- "url",
"tree",
"truncated"
]
@@ -407009,7 +409592,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -408721,7 +411304,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -409793,7 +412376,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -411072,7 +413655,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -413021,7 +415604,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -414108,7 +416691,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -415383,7 +417966,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1050924,7 +1053507,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1053773,7 +1056356,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1056622,7 +1059205,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1057622,7 +1060205,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1058450,7 +1061033,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
@@ -1059281,7 +1061864,7 @@
},
"automatic_copilot_code_review_enabled": {
"type": "boolean",
- "description": "> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
+ "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review."
},
"dismiss_stale_reviews_on_push": {
"type": "boolean",
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 5403169d0..4abf0ec91 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
+++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
@@ -95,6 +95,8 @@ tags:
description: Manage private registry configurations.
- name: hosted-compute
description: Manage hosted compute networking resources.
+- name: campaigns
+ description: Endpoints to manage campaigns via the REST API.
servers:
- url: https://api.github.com
externalDocs:
@@ -847,7 +849,7 @@ paths:
- subscriptions_url
- type
- url
- type: &253
+ type: &256
type: string
description: The type of credit the user is receiving.
enum:
@@ -1013,7 +1015,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &581
+ - &584
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1576,7 +1578,7 @@ paths:
schema:
type: integer
default: 30
- - &166
+ - &170
name: cursor
description: 'Used for pagination: the starting delivery from which the page
of deliveries is fetched. Refer to the `link` header for the next and previous
@@ -1592,7 +1594,7 @@ paths:
application/json:
schema:
type: array
- items: &167
+ items: &171
title: Simple webhook delivery
description: Delivery made by a webhook, without request and response
information.
@@ -1672,7 +1674,7 @@ paths:
- installation_id
- repository_id
examples:
- default: &168
+ default: &172
value:
- id: 12345678
guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516
@@ -1800,7 +1802,7 @@ paths:
description: Response
content:
application/json:
- schema: &169
+ schema: &173
title: Webhook delivery
description: Delivery made by a webhook.
type: object
@@ -1914,7 +1916,7 @@ paths:
- request
- response
examples:
- default: &170
+ default: &174
value:
id: 12345678
guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516
@@ -2841,7 +2843,7 @@ paths:
title: Repository
description: A repository on GitHub.
type: object
- properties: &232
+ properties: &235
id:
description: Unique identifier of the repository
example: 42
@@ -3270,7 +3272,7 @@ paths:
type: boolean
description: Whether anonymous git access is enabled for
this repository
- required: &233
+ required: &236
- archive_url
- assignees_url
- blobs_url
@@ -7476,7 +7478,7 @@ paths:
description: Response
content:
application/json:
- schema: &140
+ schema: &143
type: array
description: A list of default code security configurations
items:
@@ -7492,7 +7494,7 @@ paths:
default
configuration: *42
examples:
- default: &141
+ default: &144
value:
- default_for_new_repos: public
configuration:
@@ -7800,7 +7802,7 @@ paths:
- *41
- *44
responses:
- '204': &142
+ '204': &145
description: A header with no content is returned.
'400': *14
'403': *29
@@ -7927,7 +7929,7 @@ paths:
default:
value:
default_for_new_repos: all
- configuration: &139
+ configuration: &142
value:
id: 1325
target_type: organization
@@ -8010,7 +8012,7 @@ paths:
application/json:
schema:
type: array
- items: &143
+ items: &146
type: object
description: Repositories associated with a code security configuration
and attachment status
@@ -8311,7 +8313,7 @@ paths:
summary: Example of code security configuration repositories
value:
- status: attached
- repository: &144
+ repository: &147
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -8405,7 +8407,7 @@ paths:
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise
parameters:
- *41
- - &149
+ - &153
name: state
in: query
description: |-
@@ -8414,7 +8416,7 @@ paths:
Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
schema:
type: string
- - &150
+ - &154
name: severity
in: query
description: |-
@@ -8423,7 +8425,7 @@ paths:
Can be: `low`, `medium`, `high`, `critical`
schema:
type: string
- - &151
+ - &155
name: ecosystem
in: query
description: |-
@@ -8432,14 +8434,14 @@ paths:
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
schema:
type: string
- - &152
+ - &156
name: package
in: query
description: A comma-separated list of package names. If specified, only alerts
for these packages will be returned.
schema:
type: string
- - &153
+ - &157
name: epss_percentage
in: query
description: |-
@@ -8451,7 +8453,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
- - &154
+ - &158
name: scope
in: query
description: The scope of the vulnerable dependency. If specified, only alerts
@@ -8461,7 +8463,7 @@ paths:
enum:
- development
- runtime
- - &155
+ - &159
name: sort
in: query
description: |-
@@ -8479,7 +8481,7 @@ paths:
- *48
- *39
- *40
- - &156
+ - &160
name: first
description: |-
**Deprecated**. The number of results per page (max 100), starting from the first matching result.
@@ -8492,7 +8494,7 @@ paths:
minimum: 1
maximum: 100
default: 30
- - &157
+ - &161
name: last
description: |-
**Deprecated**. The number of results per page (max 100), starting from the last matching result.
@@ -8512,7 +8514,7 @@ paths:
application/json:
schema:
type: array
- items: &158
+ items: &162
type: object
description: A Dependabot alert.
properties:
@@ -8578,7 +8580,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &426
+ security_advisory: &429
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -8797,13 +8799,13 @@ paths:
format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- updated_at: &133
+ updated_at: &136
type: string
description: 'The time that the alert was last updated in ISO
8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
- dismissed_at: &135
+ dismissed_at: &138
type: string
description: 'The time that the alert was dismissed in ISO 8601
format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -8833,14 +8835,14 @@ paths:
dismissal.
nullable: true
maxLength: 280
- fixed_at: &134
+ fixed_at: &137
type: string
description: 'The time that the alert was no longer detected
and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- auto_dismissed_at: &427
+ auto_dismissed_at: &430
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -8866,7 +8868,7 @@ paths:
- repository
additionalProperties: false
examples:
- default: &159
+ default: &163
value:
- number: 2
state: dismissed
@@ -9213,7 +9215,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
parameters:
- *41
- - &244
+ - &247
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -9224,7 +9226,7 @@ paths:
enum:
- open
- resolved
- - &245
+ - &248
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -9234,7 +9236,7 @@ paths:
required: false
schema:
type: string
- - &246
+ - &249
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -9243,7 +9245,7 @@ paths:
required: false
schema:
type: string
- - &247
+ - &250
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.
@@ -9259,7 +9261,7 @@ paths:
- *17
- *39
- *40
- - &248
+ - &251
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -9268,7 +9270,7 @@ paths:
required: false
schema:
type: string
- - &249
+ - &252
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -9277,7 +9279,7 @@ paths:
schema:
type: boolean
default: false
- - &250
+ - &253
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -9293,7 +9295,7 @@ paths:
application/json:
schema:
type: array
- items: &251
+ items: &254
type: object
properties:
number: *54
@@ -9312,14 +9314,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &573
+ state: &576
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: &574
+ resolution: &577
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -9421,7 +9423,7 @@ paths:
is base64 encoded
nullable: true
examples:
- default: &252
+ default: &255
value:
- number: 2
created_at: '2020-11-06T18:48:51Z'
@@ -9757,7 +9759,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &475
+ properties: &478
id:
type: integer
format: int64
@@ -9868,7 +9870,7 @@ paths:
description: A collection of related issues and pull
requests.
type: object
- properties: &411
+ properties: &414
url:
type: string
format: uri
@@ -9938,7 +9940,7 @@ paths:
format: date-time
example: '2012-10-09T23:39:01Z'
nullable: true
- required: &412
+ required: &415
- closed_issues
- creator
- description
@@ -10017,7 +10019,7 @@ paths:
timeline_url:
type: string
format: uri
- type: &189
+ type: &192
title: Issue Type
description: The type of issue.
type: object
@@ -10142,7 +10144,7 @@ paths:
- total
- completed
- percent_completed
- required: &476
+ required: &479
- assignee
- closed_at
- comments
@@ -10164,7 +10166,7 @@ paths:
- author_association
- created_at
- updated_at
- comment: &473
+ comment: &476
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -10731,7 +10733,7 @@ paths:
url:
type: string
format: uri
- user: &604
+ user: &607
title: Public User
description: Public User
type: object
@@ -12601,7 +12603,7 @@ paths:
- closed
- all
default: open
- - &192
+ - &195
name: labels
description: 'A list of comma separated label names. Example: `bug,ui,@high`'
in: query
@@ -12652,7 +12654,7 @@ paths:
type: array
items: *77
examples:
- default: &193
+ default: &196
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -14036,14 +14038,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &276
+ - &279
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &277
+ - &280
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -14114,7 +14116,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &288
+ '301': &291
description: Moved permanently
content:
application/json:
@@ -14136,7 +14138,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &505
+ - &508
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -14144,7 +14146,7 @@ paths:
schema:
type: boolean
default: false
- - &506
+ - &509
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -14154,7 +14156,7 @@ paths:
type: boolean
default: false
- *67
- - &507
+ - &510
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:
@@ -14190,7 +14192,7 @@ paths:
title: Minimal Repository
description: Minimal Repository
type: object
- properties: &161
+ properties: &165
id:
type: integer
format: int64
@@ -14466,7 +14468,7 @@ paths:
web_commit_signoff_required:
type: boolean
example: false
- security_and_analysis: &234
+ security_and_analysis: &237
nullable: true
type: object
properties:
@@ -14530,7 +14532,7 @@ paths:
enum:
- enabled
- disabled
- required: &162
+ required: &166
- archive_url
- assignees_url
- blobs_url
@@ -14618,7 +14620,7 @@ paths:
- url
- subscription_url
examples:
- default: &508
+ default: &511
value:
- id: '1'
repository:
@@ -15160,11 +15162,11 @@ paths:
application/json:
schema:
type: array
- items: &199
+ items: &202
title: Organization Simple
description: A GitHub organization.
type: object
- properties: &147
+ properties: &150
login:
type: string
example: github
@@ -15205,7 +15207,7 @@ paths:
type: string
example: A great organization
nullable: true
- required: &148
+ required: &151
- login
- url
- id
@@ -15219,7 +15221,7 @@ paths:
- avatar_url
- description
examples:
- default: &622
+ default: &625
value:
- login: github
id: 1
@@ -15371,7 +15373,7 @@ paths:
repositoryName: github/example
'400': *14
'403': *29
- '500': &145
+ '500': &148
description: Internal Error
content:
application/json:
@@ -16128,7 +16130,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &293
+ items: &296
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -16996,7 +16998,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &299
+ selected_actions_url: &302
type: string
description: The API URL to use to get or set the actions and
reusable workflows that are allowed to run, when `allowed_actions`
@@ -17086,7 +17088,7 @@ paths:
type: array
items: *60
examples:
- default: &616
+ default: &619
value:
total_count: 1
repositories:
@@ -17414,7 +17416,7 @@ paths:
description: Response
content:
application/json:
- schema: &303
+ schema: &306
type: object
properties:
default_workflow_permissions: &112
@@ -17465,7 +17467,7 @@ paths:
required: false
content:
application/json:
- schema: &304
+ schema: &307
type: object
properties:
default_workflow_permissions: *112
@@ -17954,7 +17956,7 @@ paths:
type: array
items: *119
examples:
- default: &607
+ default: &610
value:
total_count: 1
repositories:
@@ -18596,7 +18598,7 @@ paths:
application/json:
schema:
type: array
- items: &305
+ items: &308
title: Runner Application
description: Runner Application
type: object
@@ -18621,7 +18623,7 @@ paths:
- download_url
- filename
examples:
- default: &306
+ default: &309
value:
- os: osx
architecture: x64
@@ -18707,7 +18709,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &307
+ '201': &310
description: Response
content:
application/json:
@@ -18818,7 +18820,7 @@ paths:
- token
- expires_at
examples:
- default: &308
+ default: &311
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -18857,7 +18859,7 @@ paths:
application/json:
schema: *123
examples:
- default: &309
+ default: &312
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -18891,7 +18893,7 @@ paths:
application/json:
schema: *121
examples:
- default: &310
+ default: &313
value:
id: 23
name: MBP
@@ -19116,7 +19118,7 @@ paths:
- *94
- *120
responses:
- '200': &311
+ '200': &314
description: Response
content:
application/json:
@@ -19173,7 +19175,7 @@ paths:
parameters:
- *94
- *120
- - &312
+ - &315
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -19303,7 +19305,7 @@ paths:
description: Response
content:
application/json:
- schema: &324
+ schema: &327
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -19332,7 +19334,7 @@ paths:
- key_id
- key
examples:
- default: &325
+ default: &328
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -19745,7 +19747,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *94
- - &298
+ - &301
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/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -20280,7 +20282,7 @@ paths:
bundle_url:
type: string
examples:
- default: &338
+ default: &341
value:
attestations:
- bundle:
@@ -20399,7 +20401,7 @@ paths:
type: array
items: *4
examples:
- default: &194
+ default: &197
value:
- login: octocat
id: 1
@@ -20500,6 +20502,684 @@ paths:
enabledForGitHubApps: true
category: orgs
subcategory: blocking
+ "/orgs/{org}/campaigns":
+ get:
+ summary: List campaigns for an organization
+ description: |-
+ Lists campaigns in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/list-org-campaigns
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization
+ parameters:
+ - *94
+ - *19
+ - *17
+ - *48
+ - name: state
+ description: If specified, only campaigns with this state will be returned.
+ in: query
+ required: false
+ schema: &133
+ title: Campaign state
+ description: Indicates whether a campaign is open or closed
+ type: string
+ enum:
+ - open
+ - closed
+ - name: sort
+ description: The property by which to sort the results.
+ in: query
+ required: false
+ schema:
+ type: string
+ enum:
+ - created
+ - updated
+ - ends_at
+ - published
+ default: created
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items: &134
+ title: Campaign summary
+ description: The campaign metadata and alert stats.
+ type: object
+ properties:
+ number:
+ type: integer
+ description: The number of the newly created campaign
+ created_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was created, in
+ ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ updated_at:
+ type: string
+ format: date-time
+ description: The date and time the campaign was last updated,
+ in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ name:
+ type: string
+ description: The campaign name
+ description:
+ type: string
+ description: The campaign description
+ managers:
+ description: The campaign managers
+ type: array
+ items: *4
+ team_managers:
+ description: The campaign team managers
+ type: array
+ items: &152
+ title: Team
+ description: Groups of organization members that gives permissions
+ on specified repositories.
+ type: object
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ slug:
+ type: string
+ description:
+ type: string
+ nullable: true
+ privacy:
+ type: string
+ notification_setting:
+ type: string
+ permission:
+ type: string
+ permissions:
+ type: object
+ properties:
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ admin:
+ type: boolean
+ required:
+ - pull
+ - triage
+ - push
+ - maintain
+ - admin
+ url:
+ type: string
+ format: uri
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ members_url:
+ type: string
+ repositories_url:
+ type: string
+ format: uri
+ parent:
+ title: Team Simple
+ description: Groups of organization members that gives
+ permissions on specified repositories.
+ type: object
+ properties: &210
+ id:
+ description: Unique identifier of the team
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDQ6VGVhbTE=
+ url:
+ description: URL for the team
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1
+ members_url:
+ type: string
+ example: https://api.github.com/organizations/1/team/1/members{/member}
+ name:
+ description: Name of the team
+ type: string
+ example: Justice League
+ description:
+ description: Description of the team
+ type: string
+ nullable: true
+ example: A great team.
+ permission:
+ description: Permission that the team will have for
+ its repositories
+ type: string
+ example: admin
+ privacy:
+ description: The level of privacy this team should
+ have
+ type: string
+ example: closed
+ notification_setting:
+ description: The notification setting the team has
+ set
+ type: string
+ example: notifications_enabled
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/orgs/rails/teams/core
+ repositories_url:
+ type: string
+ format: uri
+ example: https://api.github.com/organizations/1/team/1/repos
+ slug:
+ type: string
+ example: justice-league
+ ldap_dn:
+ description: Distinguished Name (DN) that team maps
+ to within LDAP environment
+ example: uid=example,ou=users,dc=github,dc=com
+ type: string
+ required: &211
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ nullable: true
+ required:
+ - id
+ - node_id
+ - url
+ - members_url
+ - name
+ - description
+ - permission
+ - html_url
+ - repositories_url
+ - slug
+ - parent
+ published_at:
+ description: The date and time the campaign was published, in
+ ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ ends_at:
+ description: The date and time the campaign has ended, in ISO
+ 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ closed_at:
+ description: The date and time the campaign was closed, in ISO
+ 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign
+ is still open.
+ type: string
+ format: date-time
+ nullable: true
+ state: *133
+ contact_link:
+ description: The contact link of the campaign.
+ type: string
+ format: uri
+ nullable: true
+ alert_stats:
+ type: object
+ additionalProperties: false
+ properties:
+ open_count:
+ type: integer
+ description: The number of open alerts
+ closed_count:
+ type: integer
+ description: The number of closed alerts
+ in_progress_count:
+ type: integer
+ description: The number of in-progress alerts
+ required:
+ - open_count
+ - closed_count
+ - in_progress_count
+ required:
+ - number
+ - created_at
+ - updated_at
+ - description
+ - managers
+ - ends_at
+ - state
+ - contact_link
+ examples:
+ default:
+ value:
+ - number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited
+ to prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ - number: 4
+ created_at: '2024-03-30T12:29:18Z'
+ updated_at: '2024-03-30T12:29:18Z'
+ name: Mitre top 10 KEV
+ description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities)
+ to enhance security by addressing vulnerabilities actively exploited
+ by attackers. This reduces risk, prevents breaches and can help
+ protect sensitive data.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ ends_at: '2024-04-30T12:29:18Z'
+ closed_at:
+ state: open
+ headers:
+ Link: *58
+ '404': *6
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ post:
+ summary: Create a campaign for an organization
+ description: |-
+ Create a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+
+ Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
+ in the campaign.
+ tags:
+ - campaigns
+ operationId: campaigns/create-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization
+ parameters:
+ - *94
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ description: The login of each manager
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign. The date must
+ be in the future.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ code_scanning_alerts:
+ description: The code scanning alerts to include in this campaign
+ type: array
+ minItems: 1
+ items:
+ type: object
+ additionalProperties: false
+ properties:
+ repository_id:
+ type: integer
+ description: The repository id
+ alert_numbers:
+ type: array
+ description: The alert numbers
+ minItems: 1
+ items:
+ type: integer
+ required:
+ - repository_id
+ - alert_numbers
+ generate_issues:
+ description: If true, will automatically generate issues for the
+ campaign. The default is false.
+ type: boolean
+ default: false
+ required:
+ - name
+ - description
+ - ends_at
+ - code_scanning_alerts
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ description: Address critical alerts before they are exploited to
+ prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - octocat
+ ends_at: '2024-03-14T00:00:00Z'
+ code_scanning_alerts:
+ - repository_id: 1296269
+ alert_numbers:
+ - 1
+ - 2
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema: *134
+ examples:
+ default: &135
+ value:
+ number: 3
+ created_at: '2024-02-14T12:29:18Z'
+ updated_at: '2024-02-14T12:29:18Z'
+ name: Critical CodeQL alert
+ description: Address critical alerts before they are exploited
+ to prevent breaches, protect sensitive data, and mitigate financial
+ and reputational damage.
+ managers:
+ - login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ 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
+ published_at: '2024-02-14T12:29:18Z'
+ ends_at: '2024-03-14T12:29:18Z'
+ closed_at:
+ state: open
+ alert_stats:
+ open_count: 10
+ closed_count: 3
+ in_progress_count: 3
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema: *3
+ '404': *6
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema: *3
+ '429':
+ description: Too Many Requests
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ "/orgs/{org}/campaigns/{campaign_number}":
+ get:
+ summary: Get a campaign for an organization
+ description: |-
+ Gets a campaign for an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/get-campaign-summary
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization
+ parameters:
+ - *94
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema: *134
+ examples:
+ default: *135
+ '404': *6
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema: *3
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ patch:
+ summary: Update a campaign
+ description: |-
+ Updates a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/update-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign
+ parameters:
+ - *94
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ name:
+ description: The name of the campaign
+ type: string
+ minLength: 1
+ maxLength: 50
+ description:
+ description: A description for the campaign
+ type: string
+ minLength: 1
+ maxLength: 255
+ managers:
+ description: The logins of the users to set as the campaign managers.
+ At this time, only a single manager can be supplied.
+ type: array
+ maxItems: 10
+ items:
+ type: string
+ team_managers:
+ description: The slugs of the teams to set as the campaign managers.
+ type: array
+ maxItems: 10
+ items:
+ description: The slug of each team
+ type: string
+ ends_at:
+ description: The end date and time of the campaign, in ISO 8601
+ format':' YYYY-MM-DDTHH:MM:SSZ.
+ type: string
+ format: date-time
+ contact_link:
+ description: The contact link of the campaign. Must be a URI.
+ type: string
+ format: uri
+ nullable: true
+ state: *133
+ examples:
+ default:
+ value:
+ name: Critical CodeQL alerts
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema: *134
+ examples:
+ default: *135
+ '400':
+ description: Bad Request
+ content:
+ application/json:
+ schema: *3
+ '404': *6
+ '422':
+ description: Unprocessable Entity
+ content:
+ application/json:
+ schema: *3
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
+ delete:
+ summary: Delete a campaign for an organization
+ description: |-
+ Deletes a campaign in an organization.
+
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ tags:
+ - campaigns
+ operationId: campaigns/delete-campaign
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization
+ parameters:
+ - *94
+ - name: campaign_number
+ description: The campaign number.
+ in: path
+ required: true
+ schema:
+ type: integer
+ responses:
+ '204':
+ description: Deletion successful
+ '404': *6
+ '503': *65
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: campaigns
+ subcategory: campaigns
"/orgs/{org}/code-scanning/alerts":
get:
summary: List code scanning alerts for an organization
@@ -20517,17 +21197,17 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *94
- - &364
+ - &367
name: tool_name
description: The name of a code scanning tool. Only results by this tool will
be listed. You can specify the tool by using either `tool_name` or `tool_guid`,
but not both.
in: query
required: false
- schema: &136
+ schema: &139
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &365
+ - &368
name: tool_guid
description: The GUID of a code scanning tool. Only results by this tool will
be listed. Note that some code scanning tools may not include a GUID in
@@ -20535,7 +21215,7 @@ paths:
or `tool_name`, but not both.
in: query
required: false
- schema: &137
+ schema: &140
nullable: true
type: string
description: The GUID of the tool used to generate the code scanning analysis,
@@ -20550,7 +21230,7 @@ paths:
be returned.
in: query
required: false
- schema: &367
+ schema: &370
type: string
description: State of a code scanning alert.
enum:
@@ -20573,7 +21253,7 @@ paths:
be returned.
in: query
required: false
- schema: &368
+ schema: &371
type: string
description: Severity of a code scanning alert.
enum:
@@ -20596,16 +21276,16 @@ paths:
properties:
number: *54
created_at: *55
- updated_at: *133
+ updated_at: *136
url: *56
html_url: *57
- instances_url: &369
+ instances_url: &372
type: string
description: The REST API URL for fetching the list of instances
for an alert.
format: uri
readOnly: true
- state: &138
+ state: &141
type: string
description: State of a code scanning alert.
nullable: true
@@ -20613,7 +21293,7 @@ paths:
- open
- dismissed
- fixed
- fixed_at: *134
+ fixed_at: *137
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -20621,8 +21301,8 @@ paths:
properties: *20
required: *21
nullable: true
- dismissed_at: *135
- dismissed_reason: &370
+ dismissed_at: *138
+ dismissed_reason: &373
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -20631,13 +21311,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &371
+ dismissed_comment: &374
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &372
+ rule: &375
type: object
properties:
id:
@@ -20690,25 +21370,25 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &373
+ tool: &376
type: object
properties:
- name: *136
+ name: *139
version:
nullable: true
type: string
description: The version of the tool used to generate the
code scanning analysis.
- guid: *137
- most_recent_instance: &374
+ guid: *140
+ most_recent_instance: &377
type: object
properties:
- ref: &366
+ ref: &369
type: string
description: |-
The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,
`refs/heads/<branch name>` or simply `<branch name>`.
- analysis_key: &384
+ analysis_key: &387
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
@@ -20719,13 +21399,13 @@ paths:
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &385
+ category: &388
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
analyses for the same tool and commit, but performed on
different languages or different parts of the code.
- state: *138
+ state: *141
commit_sha:
type: string
message:
@@ -21351,7 +22031,7 @@ paths:
application/json:
schema: *42
examples:
- default: *139
+ default: *142
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -21379,9 +22059,9 @@ paths:
description: Response
content:
application/json:
- schema: *140
+ schema: *143
examples:
- default: *141
+ default: *144
'304': *37
'403': *29
'404': *6
@@ -21430,7 +22110,7 @@ paths:
- 32
- 91
responses:
- '204': *142
+ '204': *145
'400': *14
'403': *29
'404': *6
@@ -21465,7 +22145,7 @@ paths:
application/json:
schema: *42
examples:
- default: *139
+ default: *142
'304': *37
'403': *29
'404': *6
@@ -21727,7 +22407,7 @@ paths:
- *94
- *44
responses:
- '204': *142
+ '204': *145
'400': *14
'403': *29
'404': *6
@@ -21865,7 +22545,7 @@ paths:
default:
value:
default_for_new_repos: all
- configuration: *139
+ configuration: *142
'403': *29
'404': *6
x-github:
@@ -21918,13 +22598,13 @@ paths:
application/json:
schema:
type: array
- items: *143
+ items: *146
examples:
default:
summary: Example of code security configuration repositories
value:
- status: attached
- repository: *144
+ repository: *147
'403': *29
'404': *6
x-github:
@@ -21964,7 +22644,7 @@ paths:
type: integer
codespaces:
type: array
- items: &195
+ items: &198
type: object
title: Codespace
description: A codespace.
@@ -21994,7 +22674,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &397
+ properties: &400
name:
type: string
description: The name of the machine.
@@ -22036,7 +22716,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &398
+ required: &401
- name
- display_name
- operating_system
@@ -22241,7 +22921,7 @@ paths:
- pulls_url
- recent_folders
examples:
- default: &196
+ default: &199
value:
total_count: 3
codespaces:
@@ -22651,7 +23331,7 @@ paths:
stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop
recent_folders: []
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -22717,7 +23397,7 @@ paths:
description: Users are neither members nor collaborators of this organization.
'404': *6
'422': *15
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -22772,7 +23452,7 @@ paths:
description: Users are neither members nor collaborators of this organization.
'404': *6
'422': *15
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -22826,7 +23506,7 @@ paths:
description: Users are neither members nor collaborators of this organization.
'404': *6
'422': *15
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -22865,7 +23545,7 @@ paths:
type: integer
secrets:
type: array
- items: &146
+ items: &149
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -22904,7 +23584,7 @@ paths:
- updated_at
- visibility
examples:
- default: &399
+ default: &402
value:
total_count: 2
secrets:
@@ -22942,7 +23622,7 @@ paths:
description: Response
content:
application/json:
- schema: &400
+ schema: &403
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -22971,7 +23651,7 @@ paths:
- key_id
- key
examples:
- default: &401
+ default: &404
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -23001,9 +23681,9 @@ paths:
description: Response
content:
application/json:
- schema: *146
+ schema: *149
examples:
- default: &403
+ default: &406
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -23415,7 +24095,7 @@ paths:
cli: enabled
public_code_suggestions: block
plan_type: business
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -23470,7 +24150,7 @@ paths:
currently being billed.
seats:
type: array
- items: &198
+ items: &201
title: Copilot Business Seat Detail
description: Information about a Copilot Business seat assignment
for a user, team, or organization.
@@ -23481,152 +24161,14 @@ paths:
title: Organization Simple
description: A GitHub organization.
type: object
- properties: *147
- required: *148
+ properties: *150
+ required: *151
nullable: true
assigning_team:
description: The team through which the assignee is granted
access to GitHub Copilot, if applicable.
oneOf:
- - &188
- title: Team
- description: Groups of organization members that gives
- permissions on specified repositories.
- type: object
- properties:
- id:
- type: integer
- node_id:
- type: string
- name:
- type: string
- slug:
- type: string
- description:
- type: string
- nullable: true
- privacy:
- type: string
- notification_setting:
- type: string
- permission:
- type: string
- permissions:
- type: object
- properties:
- pull:
- type: boolean
- triage:
- type: boolean
- push:
- type: boolean
- maintain:
- type: boolean
- admin:
- type: boolean
- required:
- - pull
- - triage
- - push
- - maintain
- - admin
- url:
- type: string
- format: uri
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- members_url:
- type: string
- repositories_url:
- type: string
- format: uri
- parent:
- title: Team Simple
- description: Groups of organization members that gives
- permissions on specified repositories.
- type: object
- properties: &207
- id:
- description: Unique identifier of the team
- type: integer
- example: 1
- node_id:
- type: string
- example: MDQ6VGVhbTE=
- url:
- description: URL for the team
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1
- members_url:
- type: string
- example: https://api.github.com/organizations/1/team/1/members{/member}
- name:
- description: Name of the team
- type: string
- example: Justice League
- description:
- description: Description of the team
- type: string
- nullable: true
- example: A great team.
- permission:
- description: Permission that the team will have
- for its repositories
- type: string
- example: admin
- privacy:
- description: The level of privacy this team should
- have
- type: string
- example: closed
- notification_setting:
- description: The notification setting the team
- has set
- type: string
- example: notifications_enabled
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/rails/teams/core
- repositories_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/1/repos
- slug:
- type: string
- example: justice-league
- ldap_dn:
- description: Distinguished Name (DN) that team
- maps to within LDAP environment
- example: uid=example,ou=users,dc=github,dc=com
- type: string
- required: &208
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- nullable: true
- required:
- - id
- - node_id
- - url
- - members_url
- - name
- - description
- - permission
- - html_url
- - repositories_url
- - slug
- - parent
+ - *152
- title: Enterprise Team
description: Group of enterprise owners and/or members
type: object
@@ -23791,7 +24333,7 @@ paths:
site_admin: false
headers:
Link: *58
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -23866,7 +24408,7 @@ paths:
default:
value:
seats_created: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -23944,7 +24486,7 @@ paths:
default:
value:
seats_cancelled: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -24023,7 +24565,7 @@ paths:
default:
value:
seats_created: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -24101,7 +24643,7 @@ paths:
default:
value:
seats_cancelled: 5
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -24172,7 +24714,7 @@ paths:
application/json:
schema:
type: array
- items: &258
+ items: &261
title: Copilot Usage Metrics
description: Copilot usage metrics for a given day.
type: object
@@ -24479,7 +25021,7 @@ paths:
- date
additionalProperties: true
examples:
- default: &259
+ default: &262
value:
- date: '2024-06-24'
total_active_users: 24
@@ -24578,10 +25120,10 @@ paths:
custom_model_training_date: '2024-02-01'
total_pr_summaries_created: 10
total_engaged_users: 4
- '500': *145
+ '500': *148
'403': *29
'404': *6
- '422': &260
+ '422': &263
description: Copilot Usage Merics API setting is disabled at the organization
or enterprise level.
content:
@@ -24609,18 +25151,18 @@ paths:
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization
parameters:
- *94
- - *149
- - *150
- - *151
- - *152
- *153
- *154
- *155
+ - *156
+ - *157
+ - *158
+ - *159
- *48
- *39
- *40
- - *156
- - *157
+ - *160
+ - *161
- *17
responses:
'200':
@@ -24629,9 +25171,9 @@ paths:
application/json:
schema:
type: array
- items: *158
+ items: *162
examples:
- default: *159
+ default: *163
'304': *37
'400': *14
'403': *29
@@ -24675,7 +25217,7 @@ paths:
type: integer
secrets:
type: array
- items: &160
+ items: &164
title: Dependabot Secret for an Organization
description: Secrets for GitHub Dependabot for an organization.
type: object
@@ -24752,7 +25294,7 @@ paths:
description: Response
content:
application/json:
- schema: &430
+ schema: &433
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -24769,7 +25311,7 @@ paths:
- key_id
- key
examples:
- default: &431
+ default: &434
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -24799,7 +25341,7 @@ paths:
description: Response
content:
application/json:
- schema: *160
+ schema: *164
examples:
default:
value:
@@ -25096,7 +25638,7 @@ paths:
application/json:
schema:
type: array
- items: &210
+ items: &213
title: Package
description: A software package
type: object
@@ -25146,8 +25688,8 @@ paths:
title: Minimal Repository
description: Minimal Repository
type: object
- properties: *161
- required: *162
+ properties: *165
+ required: *166
nullable: true
created_at:
type: string
@@ -25166,7 +25708,7 @@ paths:
- created_at
- updated_at
examples:
- default: &211
+ default: &214
value:
- id: 197
name: hello_docker
@@ -25333,7 +25875,7 @@ paths:
application/json:
schema:
type: array
- items: &185
+ items: &189
title: Organization Invitation
description: Organization Invitation
type: object
@@ -25380,7 +25922,7 @@ paths:
- invitation_teams_url
- node_id
examples:
- default: &186
+ default: &190
value:
- id: 1
login: monalisa
@@ -25447,7 +25989,7 @@ paths:
application/json:
schema:
type: array
- items: &163
+ items: &167
title: Org Hook
description: Org Hook
type: object
@@ -25618,9 +26160,9 @@ paths:
description: Response
content:
application/json:
- schema: *163
+ schema: *167
examples:
- default: &164
+ default: &168
value:
id: 1
url: https://api.github.com/orgs/octocat/hooks/1
@@ -25668,7 +26210,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook
parameters:
- *94
- - &165
+ - &169
name: hook_id
description: The unique identifier of the hook. You can find this value in
the `X-GitHub-Hook-ID` header of a webhook delivery.
@@ -25681,9 +26223,9 @@ paths:
description: Response
content:
application/json:
- schema: *163
+ schema: *167
examples:
- default: *164
+ default: *168
'404': *6
x-github:
githubCloudOnly: false
@@ -25711,7 +26253,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
requestBody:
required: false
content:
@@ -25756,7 +26298,7 @@ paths:
description: Response
content:
application/json:
- schema: *163
+ schema: *167
examples:
default:
value:
@@ -25798,7 +26340,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
responses:
'204':
description: Response
@@ -25826,7 +26368,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization
parameters:
- *94
- - *165
+ - *169
responses:
'200':
description: Response
@@ -25857,7 +26399,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization
parameters:
- *94
- - *165
+ - *169
requestBody:
required: false
content:
@@ -25908,9 +26450,9 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
- *17
- - *166
+ - *170
responses:
'200':
description: Response
@@ -25918,9 +26460,9 @@ paths:
application/json:
schema:
type: array
- items: *167
+ items: *171
examples:
- default: *168
+ default: *172
'400': *14
'422': *15
x-github:
@@ -25946,16 +26488,16 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *169
+ schema: *173
examples:
- default: *170
+ default: *174
'400': *14
'422': *15
x-github:
@@ -25981,7 +26523,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
- *16
responses:
'202': *47
@@ -26011,7 +26553,7 @@ paths:
url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook
parameters:
- *94
- - *165
+ - *169
responses:
'204':
description: Response
@@ -26034,7 +26576,7 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor
parameters:
- *94
- - &175
+ - &179
name: actor_type
in: path
description: The type of the actor
@@ -26047,14 +26589,14 @@ paths:
- fine_grained_pat
- oauth_app
- github_app_user_to_server
- - &176
+ - &180
name: actor_id
in: path
description: The ID of the actor
required: true
schema:
type: integer
- - &171
+ - &175
name: min_timestamp
description: 'The minimum timestamp to query for stats. This is a timestamp
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -26062,7 +26604,7 @@ paths:
required: true
schema:
type: string
- - &172
+ - &176
name: max_timestamp
description: 'The maximum timestamp to query for stats. Defaults to the time
30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -26156,12 +26698,12 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats
parameters:
- *94
- - *171
- - *172
+ - *175
+ - *176
- *19
- *17
- *48
- - &181
+ - &185
name: sort
description: The property to sort the results by.
in: query
@@ -26240,14 +26782,14 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats
parameters:
- *94
- - *171
- - *172
+ - *175
+ - *176
responses:
'200':
description: Response
content:
application/json:
- schema: &173
+ schema: &177
title: Summary Stats
description: API Insights usage summary stats for an organization
type: object
@@ -26263,7 +26805,7 @@ paths:
type: integer
format: int64
examples:
- default: &174
+ default: &178
value:
total_request_count: 34225
rate_limited_request_count: 23
@@ -26284,23 +26826,23 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user
parameters:
- *94
- - &177
+ - &181
name: user_id
in: path
description: The ID of the user to query for stats
required: true
schema:
type: string
- - *171
- - *172
+ - *175
+ - *176
responses:
'200':
description: Response
content:
application/json:
- schema: *173
+ schema: *177
examples:
- default: *174
+ default: *178
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26319,18 +26861,18 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor
parameters:
- *94
- - *171
- - *172
- *175
- *176
+ - *179
+ - *180
responses:
'200':
description: Response
content:
application/json:
- schema: *173
+ schema: *177
examples:
- default: *174
+ default: *178
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26348,9 +26890,9 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-time-stats
parameters:
- *94
- - *171
- - *172
- - &178
+ - *175
+ - *176
+ - &182
name: timestamp_increment
description: The increment of time used to breakdown the query results (5m,
10m, 1h, etc.)
@@ -26363,7 +26905,7 @@ paths:
description: Response
content:
application/json:
- schema: &179
+ schema: &183
title: Time Stats
description: API Insights usage time stats for an organization
type: array
@@ -26379,7 +26921,7 @@ paths:
type: integer
format: int64
examples:
- default: &180
+ default: &184
value:
- timestamp: '2024-09-11T15:00:00Z'
total_request_count: 34225
@@ -26416,18 +26958,18 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user
parameters:
- *94
- - *177
- - *171
- - *172
- - *178
+ - *181
+ - *175
+ - *176
+ - *182
responses:
'200':
description: Response
content:
application/json:
- schema: *179
+ schema: *183
examples:
- default: *180
+ default: *184
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26445,19 +26987,19 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor
parameters:
- *94
+ - *179
+ - *180
- *175
- *176
- - *171
- - *172
- - *178
+ - *182
responses:
'200':
description: Response
content:
application/json:
- schema: *179
+ schema: *183
examples:
- default: *180
+ default: *184
x-github:
enabledForGitHubApps: true
category: orgs
@@ -26475,13 +27017,13 @@ paths:
url: https://docs.github.com/rest/orgs/api-insights#get-user-stats
parameters:
- *94
- - *177
- - *171
- - *172
+ - *181
+ - *175
+ - *176
- *19
- *17
- *48
- - *181
+ - *185
- name: actor_name_substring
in: query
description: Providing a substring will filter results where the actor name
@@ -26562,7 +27104,7 @@ paths:
application/json:
schema: *22
examples:
- default: &469
+ default: &472
value:
id: 1
account:
@@ -26728,12 +27270,12 @@ paths:
application/json:
schema:
anyOf:
- - &183
+ - &187
title: Interaction Limits
description: Interaction limit settings.
type: object
properties:
- limit: &182
+ limit: &186
type: string
description: The type of GitHub user that can comment, open
issues, or create pull requests while the interaction limit
@@ -26758,7 +27300,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &184
+ default: &188
value:
limit: collaborators_only
origin: organization
@@ -26787,13 +27329,13 @@ paths:
required: true
content:
application/json:
- schema: &470
+ schema: &473
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
type: object
properties:
- limit: *182
+ limit: *186
expiry:
type: string
description: 'The duration of the interaction restriction. Default:
@@ -26817,9 +27359,9 @@ paths:
description: Response
content:
application/json:
- schema: *183
+ schema: *187
examples:
- default: *184
+ default: *188
'422': *15
x-github:
githubCloudOnly: false
@@ -26895,9 +27437,9 @@ paths:
application/json:
schema:
type: array
- items: *185
+ items: *189
examples:
- default: *186
+ default: *190
headers:
Link: *58
'404': *6
@@ -26974,7 +27516,7 @@ paths:
description: Response
content:
application/json:
- schema: *185
+ schema: *189
examples:
default:
value:
@@ -27029,7 +27571,7 @@ paths:
url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation
parameters:
- *94
- - &187
+ - &191
name: invitation_id
description: The unique identifier of the invitation.
in: path
@@ -27060,7 +27602,7 @@ paths:
url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams
parameters:
- *94
- - *187
+ - *191
- *17
- *19
responses:
@@ -27070,9 +27612,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: &209
+ default: &212
value:
- id: 1
node_id: MDQ6VGVhbTE=
@@ -27115,7 +27657,7 @@ paths:
application/json:
schema:
type: array
- items: *189
+ items: *192
examples:
default:
value:
@@ -27200,9 +27742,9 @@ paths:
description: Response
content:
application/json:
- schema: *189
+ schema: *192
examples:
- default: &190
+ default: &193
value:
id: 410
node_id: IT_kwDNAd3NAZo
@@ -27235,7 +27777,7 @@ paths:
url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization
parameters:
- *94
- - &191
+ - &194
name: issue_type_id
description: The unique identifier of the issue type.
in: path
@@ -27288,9 +27830,9 @@ paths:
description: Response
content:
application/json:
- schema: *189
+ schema: *192
examples:
- default: *190
+ default: *193
'404': *6
'422': *7
x-github:
@@ -27315,7 +27857,7 @@ paths:
url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization
parameters:
- *94
- - *191
+ - *194
responses:
'204':
description: Response
@@ -27378,7 +27920,7 @@ paths:
- closed
- all
default: open
- - *192
+ - *195
- name: type
description: Can be the name of an issue type.
in: query
@@ -27409,7 +27951,7 @@ paths:
type: array
items: *77
examples:
- default: *193
+ default: *196
headers:
Link: *58
'404': *6
@@ -27467,7 +28009,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'422': *15
@@ -27563,11 +28105,11 @@ paths:
type: integer
codespaces:
type: array
- items: *195
+ items: *198
examples:
- default: *196
+ default: *199
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27592,7 +28134,7 @@ paths:
parameters:
- *94
- *132
- - &197
+ - &200
name: codespace_name
in: path
required: true
@@ -27602,7 +28144,7 @@ paths:
responses:
'202': *47
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27627,15 +28169,15 @@ paths:
parameters:
- *94
- *132
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: &396
+ default: &399
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -27777,7 +28319,7 @@ paths:
recent_folders: []
template:
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27815,7 +28357,7 @@ paths:
description: The user's GitHub Copilot seat details, including usage.
content:
application/json:
- schema: *198
+ schema: *201
examples:
default:
value:
@@ -27858,7 +28400,7 @@ paths:
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
parent:
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -27890,7 +28432,7 @@ paths:
description: Response
content:
application/json:
- schema: &200
+ schema: &203
title: Org Membership
description: Org Membership
type: object
@@ -27919,7 +28461,7 @@ paths:
type: string
format: uri
example: https://api.github.com/orgs/octocat
- organization: *199
+ organization: *202
user:
title: Simple User
description: A GitHub user.
@@ -27942,7 +28484,7 @@ paths:
- organization
- user
examples:
- response-if-user-has-an-active-admin-membership-with-organization: &201
+ response-if-user-has-an-active-admin-membership-with-organization: &204
summary: Response if user has an active admin membership with organization
value:
url: https://api.github.com/orgs/octocat/memberships/defunkt
@@ -28039,9 +28581,9 @@ paths:
description: Response
content:
application/json:
- schema: *200
+ schema: *203
examples:
- response-if-user-already-had-membership-with-organization: *201
+ response-if-user-already-had-membership-with-organization: *204
'422': *15
'403': *29
x-github:
@@ -28109,7 +28651,7 @@ paths:
application/json:
schema:
type: array
- items: &202
+ items: &205
title: Migration
description: A migration.
type: object
@@ -28438,7 +28980,7 @@ paths:
description: Response
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -28617,7 +29159,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status
parameters:
- *94
- - &203
+ - &206
name: migration_id
description: The unique identifier of the migration.
in: path
@@ -28644,7 +29186,7 @@ paths:
* `failed`, which means the migration failed.
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -28814,7 +29356,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive
parameters:
- *94
- - *203
+ - *206
responses:
'302':
description: Response
@@ -28836,7 +29378,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive
parameters:
- *94
- - *203
+ - *206
responses:
'204':
description: Response
@@ -28860,8 +29402,8 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository
parameters:
- *94
- - *203
- - &621
+ - *206
+ - &624
name: repo_name
description: repo_name parameter
in: path
@@ -28889,7 +29431,7 @@ paths:
url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration
parameters:
- *94
- - *203
+ - *206
- *17
- *19
responses:
@@ -28901,7 +29443,7 @@ paths:
type: array
items: *119
examples:
- default: &216
+ default: &219
value:
- id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -29054,7 +29596,7 @@ paths:
roles:
type: array
description: The list of organization roles available to the organization.
- items: &206
+ items: &209
title: Organization Role
description: Organization roles
type: object
@@ -29202,7 +29744,7 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team
parameters:
- *94
- - &204
+ - &207
name: team_slug
description: The slug of the team name.
in: path
@@ -29234,8 +29776,8 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team
parameters:
- *94
- - *204
- - &205
+ - *207
+ - &208
name: role_id
description: The unique identifier of the role.
in: path
@@ -29271,8 +29813,8 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team
parameters:
- *94
- - *204
- - *205
+ - *207
+ - *208
responses:
'204':
description: Response
@@ -29325,7 +29867,7 @@ paths:
parameters:
- *94
- *132
- - *205
+ - *208
responses:
'204':
description: Response
@@ -29357,7 +29899,7 @@ paths:
parameters:
- *94
- *132
- - *205
+ - *208
responses:
'204':
description: Response
@@ -29386,13 +29928,13 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role
parameters:
- *94
- - *205
+ - *208
responses:
'200':
description: Response
content:
application/json:
- schema: *206
+ schema: *209
examples:
default:
value:
@@ -29443,7 +29985,7 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role
parameters:
- *94
- - *205
+ - *208
- *17
- *19
responses:
@@ -29521,8 +30063,8 @@ paths:
description: Groups of organization members that gives permissions
on specified repositories.
type: object
- properties: *207
- required: *208
+ properties: *210
+ required: *211
nullable: true
required:
- id
@@ -29537,7 +30079,7 @@ paths:
- slug
- parent
examples:
- default: *209
+ default: *212
headers:
Link: *58
'404':
@@ -29567,7 +30109,7 @@ paths:
url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role
parameters:
- *94
- - *205
+ - *208
- *17
- *19
responses:
@@ -29595,13 +30137,13 @@ paths:
inherited_from:
description: Team the user has gotten the role through
type: array
- items: &254
+ items: &257
title: Team Simple
description: Groups of organization members that gives permissions
on specified repositories.
type: object
- properties: *207
- required: *208
+ properties: *210
+ required: *211
name:
nullable: true
type: string
@@ -29696,7 +30238,7 @@ paths:
- type
- url
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404':
@@ -29744,7 +30286,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -29886,7 +30428,7 @@ paths:
- nuget
- container
- *94
- - &623
+ - &626
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -29922,12 +30464,12 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *211
+ default: *214
'403': *29
'401': *25
- '400': &625
+ '400': &628
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -29949,7 +30491,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization
parameters:
- - &212
+ - &215
name: package_type
description: The type of supported package. Packages in GitHub's Gradle registry
have the type `maven`. Docker images pushed to GitHub's Container registry
@@ -29967,7 +30509,7 @@ paths:
- docker
- nuget
- container
- - &213
+ - &216
name: package_name
description: The name of the package.
in: path
@@ -29980,7 +30522,7 @@ paths:
description: Response
content:
application/json:
- schema: *210
+ schema: *213
examples:
default:
value:
@@ -30032,8 +30574,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
responses:
'204':
@@ -30066,8 +30608,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
- name: token
description: package token
@@ -30100,8 +30642,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
- *19
- *17
@@ -30122,7 +30664,7 @@ paths:
application/json:
schema:
type: array
- items: &214
+ items: &217
title: Package Version
description: A version of a software package
type: object
@@ -30247,10 +30789,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *94
- - &215
+ - &218
name: package_version_id
description: Unique identifier of the package version.
in: path
@@ -30262,7 +30804,7 @@ paths:
description: Response
content:
application/json:
- schema: *214
+ schema: *217
examples:
default:
value:
@@ -30298,10 +30840,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization
parameters:
- - *212
- - *213
- - *94
- *215
+ - *216
+ - *94
+ - *218
responses:
'204':
description: Response
@@ -30333,10 +30875,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization
parameters:
- - *212
- - *213
- - *94
- *215
+ - *216
+ - *94
+ - *218
responses:
'204':
description: Response
@@ -30366,7 +30908,7 @@ paths:
- *94
- *17
- *19
- - &217
+ - &220
name: sort
description: The property by which to sort the results.
in: query
@@ -30377,7 +30919,7 @@ paths:
- created_at
default: created_at
- *48
- - &218
+ - &221
name: owner
description: A list of owner usernames to use to filter the results.
in: query
@@ -30388,7 +30930,7 @@ paths:
items:
type: string
example: owner[]=octocat1,owner[]=octocat2
- - &219
+ - &222
name: repository
description: The name of the repository to use to filter the results.
in: query
@@ -30396,7 +30938,7 @@ paths:
schema:
type: string
example: Hello-World
- - &220
+ - &223
name: permission
description: The permission to use to filter the results.
in: query
@@ -30404,7 +30946,7 @@ paths:
schema:
type: string
example: issues_read
- - &221
+ - &224
name: last_used_before
description: 'Only show fine-grained personal access tokens used before the
given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -30414,7 +30956,7 @@ paths:
schema:
type: string
format: date-time
- - &222
+ - &225
name: last_used_after
description: 'Only show fine-grained personal access tokens used after the
given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -30424,7 +30966,7 @@ paths:
schema:
type: string
format: date-time
- - &223
+ - &226
name: token_id
description: The ID of the token
in: query
@@ -30436,7 +30978,7 @@ paths:
type: string
example: token_id[]=1,token_id[]=2
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
@@ -30629,7 +31171,7 @@ paths:
action: deny
reason: Access is too broad.
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
@@ -30690,11 +31232,11 @@ paths:
action: deny
reason: This request is denied because the access is too broad.
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -30726,7 +31268,7 @@ paths:
- *17
- *19
responses:
- '500': *145
+ '500': *148
'404': *6
'403': *29
'200':
@@ -30737,7 +31279,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -30763,16 +31305,16 @@ paths:
- *94
- *17
- *19
- - *217
- - *48
- - *218
- - *219
- *220
+ - *48
- *221
- *222
- *223
+ - *224
+ - *225
+ - *226
responses:
- '500': *145
+ '500': *148
'422': *15
'404': *6
'403': *29
@@ -30954,7 +31496,7 @@ paths:
- 1296269
- 1296280
responses:
- '500': *145
+ '500': *148
'404': *6
'202': *47
'403': *29
@@ -31007,9 +31549,9 @@ paths:
value:
action: revoke
responses:
- '500': *145
+ '500': *148
'404': *6
- '204': *142
+ '204': *145
'403': *29
'422': *15
x-github:
@@ -31041,7 +31583,7 @@ paths:
- *17
- *19
responses:
- '500': *145
+ '500': *148
'404': *6
'403': *29
'200':
@@ -31052,7 +31594,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -31096,7 +31638,7 @@ paths:
type: integer
configurations:
type: array
- items: &224
+ items: &227
title: Organization private registry
description: Private registry configuration for an organization
type: object
@@ -31302,7 +31844,7 @@ paths:
- created_at
- updated_at
examples:
- org-private-registry-with-selected-visibility: &225
+ org-private-registry-with-selected-visibility: &228
value:
name: MAVEN_REPOSITORY_SECRET
registry_type: maven_repository
@@ -31402,9 +31944,9 @@ paths:
description: The specified private registry configuration for the organization
content:
application/json:
- schema: *224
+ schema: *227
examples:
- default: *225
+ default: *228
'404': *6
x-github:
githubCloudOnly: false
@@ -31554,7 +32096,7 @@ paths:
application/json:
schema:
type: array
- items: &226
+ items: &229
title: Project
description: Projects are a way to organize columns and cards of
work.
@@ -31727,7 +32269,7 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
default:
value:
@@ -31765,7 +32307,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '410': &285
+ '410': &288
description: Gone
content:
application/json:
@@ -31800,7 +32342,7 @@ paths:
application/json:
schema:
type: array
- items: &227
+ items: &230
title: Organization Custom Property
description: Custom property defined on an organization
type: object
@@ -31866,7 +32408,7 @@ paths:
- property_name
- value_type
examples:
- default: &228
+ default: &231
value:
- property_name: environment
url: https://api.github.com/orgs/github/properties/schema/environment
@@ -31925,7 +32467,7 @@ paths:
properties:
type: array
description: The array of custom properties to create or update.
- items: *227
+ items: *230
minItems: 1
maxItems: 100
required:
@@ -31955,9 +32497,9 @@ paths:
application/json:
schema:
type: array
- items: *227
+ items: *230
examples:
- default: *228
+ default: *231
'403': *29
'404': *6
x-github:
@@ -31979,7 +32521,7 @@ paths:
url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization
parameters:
- *94
- - &229
+ - &232
name: custom_property_name
description: The custom property name
in: path
@@ -31991,9 +32533,9 @@ paths:
description: Response
content:
application/json:
- schema: *227
+ schema: *230
examples:
- default: &230
+ default: &233
value:
property_name: environment
url: https://api.github.com/orgs/github/properties/schema/environment
@@ -32028,7 +32570,7 @@ paths:
url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization
parameters:
- *94
- - *229
+ - *232
requestBody:
required: true
content:
@@ -32097,9 +32639,9 @@ paths:
description: Response
content:
application/json:
- schema: *227
+ schema: *230
examples:
- default: *230
+ default: *233
'403': *29
'404': *6
x-github:
@@ -32123,9 +32665,9 @@ paths:
url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization
parameters:
- *94
- - *229
+ - *232
responses:
- '204': *142
+ '204': *145
'403': *29
'404': *6
x-github:
@@ -32184,7 +32726,7 @@ paths:
example: octocat/Hello-World
properties:
type: array
- items: &231
+ items: &234
title: Custom Property Value
description: Custom property name and associated value
type: object
@@ -32271,7 +32813,7 @@ paths:
type: array
description: List of custom property names and associated values
to apply to the repositories.
- items: *231
+ items: *234
required:
- repository_names
- properties
@@ -32324,7 +32866,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -32463,7 +33005,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -32665,7 +33207,7 @@ paths:
description: Response
content:
application/json:
- schema: &287
+ schema: &290
title: Full Repository
description: Full Repository
type: object
@@ -32942,8 +33484,8 @@ paths:
title: Repository
description: A repository on GitHub.
type: object
- properties: *232
- required: *233
+ properties: *235
+ required: *236
nullable: true
temp_clone_token:
type: string
@@ -33058,7 +33600,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &418
+ properties: &421
url:
type: string
format: uri
@@ -33074,12 +33616,12 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &419
+ required: &422
- url
- key
- name
- html_url
- security_and_analysis: *234
+ security_and_analysis: *237
custom_properties:
type: object
description: The custom properties that were defined for the repository.
@@ -33163,7 +33705,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &289
+ default: &292
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -33684,7 +34226,7 @@ paths:
- *94
- *17
- *19
- - &558
+ - &561
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -33702,7 +34244,7 @@ paths:
application/json:
schema:
type: array
- items: &241
+ items: &244
title: Repository ruleset
type: object
description: A set of rules to apply when specified conditions are
@@ -33737,7 +34279,7 @@ paths:
source:
type: string
description: The name of the source
- enforcement: &237
+ enforcement: &240
type: string
description: The enforcement level of the ruleset. `evaluate`
allows admins to test rules before enforcing them. Admins
@@ -33750,7 +34292,7 @@ paths:
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: &238
+ items: &241
title: Repository Ruleset Bypass Actor
type: object
description: An actor that can bypass rules in a ruleset
@@ -33815,7 +34357,7 @@ paths:
conditions:
nullable: true
anyOf:
- - &235
+ - &238
title: Repository ruleset conditions for ref names
type: object
description: Parameters for a repository ruleset ref name
@@ -33839,7 +34381,7 @@ paths:
match.
items:
type: string
- - &239
+ - &242
title: Organization ruleset conditions
type: object
description: |-
@@ -33853,7 +34395,7 @@ paths:
description: Conditions to target repositories by name and
refs by name
allOf:
- - *235
+ - *238
- title: Repository ruleset conditions for repository names
type: object
description: Parameters for a repository name condition
@@ -33887,7 +34429,7 @@ paths:
description: Conditions to target repositories by id and
refs by name
allOf:
- - *235
+ - *238
- title: Repository ruleset conditions for repository IDs
type: object
description: Parameters for a repository ID condition
@@ -33909,7 +34451,7 @@ paths:
description: Conditions to target repositories by property
and refs by name
allOf:
- - *235
+ - *238
- title: Repository ruleset conditions for repository properties
type: object
description: Parameters for a repository property condition
@@ -33922,7 +34464,7 @@ paths:
description: The repository properties and values
to include. All of these properties must match
for the condition to pass.
- items: &236
+ items: &239
title: Repository ruleset property targeting
definition
type: object
@@ -33955,17 +34497,17 @@ paths:
description: The repository properties and values
to exclude. The condition will not pass if any
of these properties match.
- items: *236
+ items: *239
required:
- repository_property
rules:
type: array
- items: &240
+ items: &243
title: Repository Rule
type: object
description: A repository rule.
oneOf:
- - &536
+ - &539
title: creation
description: Only allow users with bypass permission to
create matching refs.
@@ -33977,7 +34519,7 @@ paths:
type: string
enum:
- creation
- - &537
+ - &540
title: update
description: Only allow users with bypass permission to
update matching refs.
@@ -33998,7 +34540,7 @@ paths:
repository
required:
- update_allows_fetch_and_merge
- - &539
+ - &542
title: deletion
description: Only allow users with bypass permissions to
delete matching refs.
@@ -34010,7 +34552,7 @@ paths:
type: string
enum:
- deletion
- - &540
+ - &543
title: required_linear_history
description: Prevent merge commits from being pushed to
matching refs.
@@ -34022,7 +34564,7 @@ paths:
type: string
enum:
- required_linear_history
- - &541
+ - &544
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -34100,7 +34642,7 @@ paths:
- merge_method
- min_entries_to_merge
- min_entries_to_merge_wait_minutes
- - &542
+ - &545
title: required_deployments
description: Choose which environments must be successfully
deployed to before refs can be pushed into a ref that
@@ -34124,7 +34666,7 @@ paths:
type: string
required:
- required_deployment_environments
- - &543
+ - &546
title: required_signatures
description: Commits pushed to matching refs must have verified
signatures.
@@ -34136,7 +34678,7 @@ paths:
type: string
enum:
- required_signatures
- - &544
+ - &547
title: pull_request
description: Require all commits be made to a non-target
branch and submitted via a pull request before they can
@@ -34165,11 +34707,9 @@ paths:
- rebase
automatic_copilot_code_review_enabled:
type: boolean
- description: |-
- > [!NOTE]
- > `automatic_copilot_code_review_enabled` is in beta and subject to change.
-
- Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.
+ description: Automatically request review from Copilot
+ for new pull requests, if the author has access
+ to Copilot code review.
dismiss_stale_reviews_on_push:
type: boolean
description: New, reviewable commits pushed will
@@ -34200,7 +34740,7 @@ paths:
- require_last_push_approval
- required_approving_review_count
- required_review_thread_resolution
- - &545
+ - &548
title: required_status_checks
description: Choose which status checks must pass before
the ref is updated. When enabled, commits must first be
@@ -34248,7 +34788,7 @@ paths:
required:
- required_status_checks
- strict_required_status_checks_policy
- - &546
+ - &549
title: non_fast_forward
description: Prevent users with push access from force pushing
to refs.
@@ -34260,7 +34800,7 @@ paths:
type: string
enum:
- non_fast_forward
- - &547
+ - &550
title: commit_message_pattern
description: Parameters to be used for the commit_message_pattern
rule
@@ -34296,7 +34836,7 @@ paths:
required:
- operator
- pattern
- - &548
+ - &551
title: commit_author_email_pattern
description: Parameters to be used for the commit_author_email_pattern
rule
@@ -34332,7 +34872,7 @@ paths:
required:
- operator
- pattern
- - &549
+ - &552
title: committer_email_pattern
description: Parameters to be used for the committer_email_pattern
rule
@@ -34368,7 +34908,7 @@ paths:
required:
- operator
- pattern
- - &550
+ - &553
title: branch_name_pattern
description: Parameters to be used for the branch_name_pattern
rule
@@ -34404,7 +34944,7 @@ paths:
required:
- operator
- pattern
- - &551
+ - &554
title: tag_name_pattern
description: Parameters to be used for the tag_name_pattern
rule
@@ -34440,7 +34980,7 @@ paths:
required:
- operator
- pattern
- - &552
+ - &555
title: file_path_restriction
description: Prevent commits that include changes in specified
file and folder paths from being pushed to the commit
@@ -34465,7 +35005,7 @@ paths:
type: string
required:
- restricted_file_paths
- - &553
+ - &556
title: max_file_path_length
description: Prevent commits that include file paths that
exceed the specified character limit from being pushed
@@ -34489,7 +35029,7 @@ paths:
maximum: 256
required:
- max_file_path_length
- - &554
+ - &557
title: file_extension_restriction
description: Prevent commits that include files with specified
file extensions from being pushed to the commit graph.
@@ -34512,7 +35052,7 @@ paths:
type: string
required:
- restricted_file_extensions
- - &555
+ - &558
title: max_file_size
description: Prevent commits with individual files that
exceed the specified limit from being pushed to the commit
@@ -34537,7 +35077,7 @@ paths:
maximum: 100
required:
- max_file_size
- - &556
+ - &559
title: workflows
description: Require all changes made to a targeted branch
to pass the specified workflows before they can be merged.
@@ -34587,7 +35127,7 @@ paths:
- repository_id
required:
- workflows
- - &557
+ - &560
title: code_scanning
description: Choose which tools must provide code scanning
results before the reference is updated. When configured,
@@ -34684,7 +35224,7 @@ paths:
created_at: '2023-08-15T08:43:03Z'
updated_at: '2023-09-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
post:
summary: Create an organization repository ruleset
description: Create a repository ruleset for an organization.
@@ -34721,16 +35261,16 @@ paths:
- push
- repository
default: branch
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *239
+ items: *241
+ conditions: *242
rules:
type: array
description: An array of rules within the ruleset.
- items: *240
+ items: *243
required:
- name
- enforcement
@@ -34768,9 +35308,9 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: &242
+ default: &245
value:
id: 21
name: super cool ruleset
@@ -34810,7 +35350,7 @@ paths:
created_at: '2023-08-15T08:43:03Z'
updated_at: '2023-09-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
"/orgs/{org}/rulesets/rule-suites":
get:
summary: List organization rule suites
@@ -34825,7 +35365,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *94
- - &559
+ - &562
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
@@ -34840,7 +35380,7 @@ paths:
in: query
schema:
type: string
- - &560
+ - &563
name: time_period
description: |-
The time period to filter by.
@@ -34856,14 +35396,14 @@ paths:
- week
- month
default: day
- - &561
+ - &564
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
- - &562
+ - &565
name: rule_suite_result
description: The rule results to filter on. When specified, only suites with
this result will be returned.
@@ -34883,7 +35423,7 @@ paths:
description: Response
content:
application/json:
- schema: &563
+ schema: &566
title: Rule Suites
description: Response
type: array
@@ -34938,7 +35478,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &564
+ default: &567
value:
- id: 21
actor_id: 12
@@ -34962,7 +35502,7 @@ paths:
result: pass
evaluation_result: fail
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -34982,7 +35522,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *94
- - &565
+ - &568
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -34998,7 +35538,7 @@ paths:
description: Response
content:
application/json:
- schema: &566
+ schema: &569
title: Rule Suite
description: Response
type: object
@@ -35097,7 +35637,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &567
+ default: &570
value:
id: 21
actor_id: 12
@@ -35132,7 +35672,7 @@ paths:
result: fail
rule_type: commit_message_pattern
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -35170,11 +35710,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *242
+ default: *245
'404': *6
- '500': *145
+ '500': *148
put:
summary: Update an organization repository ruleset
description: Update a ruleset for an organization.
@@ -35216,16 +35756,16 @@ paths:
- tag
- push
- repository
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *239
+ items: *241
+ conditions: *242
rules:
description: An array of rules within the ruleset.
type: array
- items: *240
+ items: *243
examples:
default:
value:
@@ -35260,11 +35800,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *242
+ default: *245
'404': *6
- '500': *145
+ '500': *148
delete:
summary: Delete an organization repository ruleset
description: Delete a ruleset for an organization.
@@ -35291,7 +35831,7 @@ paths:
'204':
description: Response
'404': *6
- '500': *145
+ '500': *148
"/orgs/{org}/rulesets/{ruleset_id}/history":
get:
summary: Get organization ruleset history
@@ -35319,7 +35859,7 @@ paths:
application/json:
schema:
type: array
- items: &243
+ items: &246
title: Ruleset version
type: object
description: The historical version of a ruleset
@@ -35343,7 +35883,7 @@ paths:
type: string
format: date-time
examples:
- default: &569
+ default: &572
value:
- version_id: 3
actor:
@@ -35361,7 +35901,7 @@ paths:
type: User
updated_at: '2024-08-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -35396,9 +35936,9 @@ paths:
description: Response
content:
application/json:
- schema: &570
+ schema: &573
allOf:
- - *243
+ - *246
- type: object
required:
- state
@@ -35445,7 +35985,7 @@ paths:
operator: contains
pattern: github
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -35468,14 +36008,14 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *94
- - *244
- - *245
- - *246
- *247
+ - *248
+ - *249
+ - *250
- *48
- *19
- *17
- - &571
+ - &574
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
@@ -35485,7 +36025,7 @@ paths:
required: false
schema:
type: string
- - &572
+ - &575
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
@@ -35495,9 +36035,9 @@ paths:
required: false
schema:
type: string
- - *248
- - *249
- - *250
+ - *251
+ - *252
+ - *253
responses:
'200':
description: Response
@@ -35505,9 +36045,9 @@ paths:
application/json:
schema:
type: array
- items: *251
+ items: *254
examples:
- default: *252
+ default: *255
headers:
Link: *58
'404': *6
@@ -35577,7 +36117,7 @@ paths:
application/json:
schema:
type: array
- items: &579
+ items: &582
description: A repository security advisory.
type: object
properties:
@@ -35797,7 +36337,7 @@ paths:
login:
type: string
description: The username of the user credited.
- type: *253
+ type: *256
credits_detailed:
type: array
nullable: true
@@ -35807,7 +36347,7 @@ paths:
type: object
properties:
user: *4
- type: *253
+ type: *256
state:
type: string
description: The state of the user's acceptance of the
@@ -35831,7 +36371,7 @@ paths:
type: array
description: A list of teams that collaborate on the advisory.
nullable: true
- items: *188
+ items: *152
private_fork:
readOnly: true
nullable: true
@@ -35868,7 +36408,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &580
+ default: &583
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -36255,9 +36795,9 @@ paths:
application/json:
schema:
type: array
- items: *254
+ items: *257
examples:
- default: *209
+ default: *212
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -36281,7 +36821,7 @@ paths:
url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team
parameters:
- *94
- - *204
+ - *207
responses:
'204':
description: Response
@@ -36307,7 +36847,7 @@ paths:
url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team
parameters:
- *94
- - *204
+ - *207
responses:
'204':
description: Response
@@ -36342,7 +36882,7 @@ paths:
description: Response
content:
application/json:
- schema: &639
+ schema: &642
type: object
properties:
total_minutes_used:
@@ -36412,7 +36952,7 @@ paths:
- included_minutes
- minutes_used_breakdown
examples:
- default: &640
+ default: &643
value:
total_minutes_used: 305
total_paid_minutes_used: 0
@@ -36448,7 +36988,7 @@ paths:
description: Response
content:
application/json:
- schema: &641
+ schema: &644
type: object
properties:
total_gigabytes_bandwidth_used:
@@ -36466,7 +37006,7 @@ paths:
- total_paid_gigabytes_bandwidth_used
- included_gigabytes_bandwidth
examples:
- default: &642
+ default: &645
value:
total_gigabytes_bandwidth_used: 50
total_paid_gigabytes_bandwidth_used: 40
@@ -36498,7 +37038,7 @@ paths:
description: Response
content:
application/json:
- schema: &643
+ schema: &646
type: object
properties:
days_left_in_billing_cycle:
@@ -36516,7 +37056,7 @@ paths:
- estimated_paid_storage_for_month
- estimated_storage_for_month
examples:
- default: &644
+ default: &647
value:
days_left_in_billing_cycle: 20
estimated_paid_storage_for_month: 15
@@ -36558,7 +37098,7 @@ paths:
type: integer
network_configurations:
type: array
- items: &255
+ items: &258
title: Hosted compute network configuration
description: A hosted compute network configuration.
type: object
@@ -36678,9 +37218,9 @@ paths:
description: Response
content:
application/json:
- schema: *255
+ schema: *258
examples:
- default: &256
+ default: &259
value:
id: 123456789ABCDEF
name: My network configuration
@@ -36709,7 +37249,7 @@ paths:
url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization
parameters:
- *94
- - &257
+ - &260
name: network_configuration_id
description: Unique identifier of the hosted compute network configuration.
in: path
@@ -36721,9 +37261,9 @@ paths:
description: Response
content:
application/json:
- schema: *255
+ schema: *258
examples:
- default: *256
+ default: *259
headers:
Link: *58
x-github:
@@ -36745,7 +37285,7 @@ paths:
url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization
parameters:
- *94
- - *257
+ - *260
requestBody:
required: true
content:
@@ -36784,9 +37324,9 @@ paths:
description: Response
content:
application/json:
- schema: *255
+ schema: *258
examples:
- default: *256
+ default: *259
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -36806,7 +37346,7 @@ paths:
url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization
parameters:
- *94
- - *257
+ - *260
responses:
'204':
description: Response
@@ -36914,7 +37454,7 @@ paths:
url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team
parameters:
- *94
- - *204
+ - *207
- name: since
description: Show usage metrics since this date. This is a timestamp in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`).
@@ -36946,13 +37486,13 @@ paths:
application/json:
schema:
type: array
- items: *258
+ items: *261
examples:
- default: *259
- '500': *145
+ default: *262
+ '500': *148
'403': *29
'404': *6
- '422': *260
+ '422': *263
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -36980,9 +37520,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
headers:
Link: *58
'403': *29
@@ -37076,7 +37616,7 @@ paths:
description: Response
content:
application/json:
- schema: &261
+ schema: &264
title: Full Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -37139,8 +37679,8 @@ paths:
description: Groups of organization members that gives permissions
on specified repositories.
type: object
- properties: *207
- required: *208
+ properties: *210
+ required: *211
nullable: true
members_count:
type: integer
@@ -37386,7 +37926,7 @@ paths:
- repos_count
- organization
examples:
- default: &262
+ default: &265
value:
id: 1
node_id: MDQ6VGVhbTE=
@@ -37457,15 +37997,15 @@ paths:
url: https://docs.github.com/rest/teams/teams#get-a-team-by-name
parameters:
- *94
- - *204
+ - *207
responses:
'200':
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
x-github:
githubCloudOnly: false
@@ -37487,7 +38027,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#update-a-team
parameters:
- *94
- - *204
+ - *207
requestBody:
required: false
content:
@@ -37549,16 +38089,16 @@ paths:
description: Response when the updated information already exists
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'201':
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
'422': *15
'403': *29
@@ -37584,7 +38124,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#delete-a-team
parameters:
- *94
- - *204
+ - *207
responses:
'204':
description: Response
@@ -37611,7 +38151,7 @@ paths:
url: https://docs.github.com/rest/teams/discussions#list-discussions
parameters:
- *94
- - *204
+ - *207
- *48
- *17
- *19
@@ -37628,7 +38168,7 @@ paths:
application/json:
schema:
type: array
- items: &263
+ items: &266
title: Team Discussion
description: A team discussion is a persistent record of a free-form
conversation within a team.
@@ -37727,7 +38267,7 @@ paths:
- updated_at
- url
examples:
- default: &594
+ default: &597
value:
- author:
login: octocat
@@ -37802,7 +38342,7 @@ paths:
url: https://docs.github.com/rest/teams/discussions#create-a-discussion
parameters:
- *94
- - *204
+ - *207
requestBody:
required: true
content:
@@ -37836,9 +38376,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: &264
+ default: &267
value:
author:
login: octocat
@@ -37911,8 +38451,8 @@ paths:
url: https://docs.github.com/rest/teams/discussions#get-a-discussion
parameters:
- *94
- - *204
- - &265
+ - *207
+ - &268
name: discussion_number
description: The number that identifies the discussion.
in: path
@@ -37924,9 +38464,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *264
+ default: *267
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -37949,8 +38489,8 @@ paths:
url: https://docs.github.com/rest/teams/discussions#update-a-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
requestBody:
required: false
content:
@@ -37973,9 +38513,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: &595
+ default: &598
value:
author:
login: octocat
@@ -38046,8 +38586,8 @@ paths:
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
responses:
'204':
description: Response
@@ -38074,8 +38614,8 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
- *48
- *17
- *19
@@ -38086,7 +38626,7 @@ paths:
application/json:
schema:
type: array
- items: &266
+ items: &269
title: Team Discussion Comment
description: A reply to a discussion within a team.
type: object
@@ -38158,7 +38698,7 @@ paths:
- updated_at
- url
examples:
- default: &596
+ default: &599
value:
- author:
login: octocat
@@ -38227,8 +38767,8 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
requestBody:
required: true
content:
@@ -38250,9 +38790,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: &267
+ default: &270
value:
author:
login: octocat
@@ -38319,9 +38859,9 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment
parameters:
- *94
- - *204
- - *265
- - &268
+ - *207
+ - *268
+ - &271
name: comment_number
description: The number that identifies the comment.
in: path
@@ -38333,9 +38873,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *267
+ default: *270
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -38358,9 +38898,9 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
requestBody:
required: true
content:
@@ -38382,9 +38922,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: &597
+ default: &600
value:
author:
login: octocat
@@ -38449,9 +38989,9 @@ paths:
url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
responses:
'204':
description: Response
@@ -38478,9 +39018,9 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion comment.
@@ -38506,7 +39046,7 @@ paths:
application/json:
schema:
type: array
- items: &269
+ items: &272
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -38549,7 +39089,7 @@ paths:
- content
- created_at
examples:
- default: &271
+ default: &274
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -38600,9 +39140,9 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
+ - *271
requestBody:
required: true
content:
@@ -38635,9 +39175,9 @@ paths:
team discussion comment
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: &270
+ default: &273
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -38666,9 +39206,9 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -38692,10 +39232,10 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction
parameters:
- *94
- - *204
- - *265
+ - *207
- *268
- - &272
+ - *271
+ - &275
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -38728,8 +39268,8 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion.
@@ -38755,9 +39295,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
x-github:
@@ -38784,8 +39324,8 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion
parameters:
- *94
- - *204
- - *265
+ - *207
+ - *268
requestBody:
required: true
content:
@@ -38817,16 +39357,16 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -38850,9 +39390,9 @@ paths:
url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction
parameters:
- *94
- - *204
- - *265
- - *272
+ - *207
+ - *268
+ - *275
responses:
'204':
description: Response
@@ -38877,7 +39417,7 @@ paths:
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -38887,9 +39427,9 @@ paths:
application/json:
schema:
type: array
- items: *185
+ items: *189
examples:
- default: *186
+ default: *190
headers:
Link: *58
x-github:
@@ -38912,7 +39452,7 @@ paths:
url: https://docs.github.com/rest/teams/members#list-team-members
parameters:
- *94
- - *204
+ - *207
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -38935,7 +39475,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -38966,14 +39506,14 @@ paths:
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user
parameters:
- *94
- - *204
+ - *207
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: &273
+ schema: &276
title: Team Membership
description: Team Membership
type: object
@@ -39000,7 +39540,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &598
+ response-if-user-is-a-team-maintainer: &601
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -39037,7 +39577,7 @@ paths:
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user
parameters:
- *94
- - *204
+ - *207
- *132
requestBody:
required: false
@@ -39063,9 +39603,9 @@ paths:
description: Response
content:
application/json:
- schema: *273
+ schema: *276
examples:
- response-if-users-membership-with-team-is-now-pending: &599
+ response-if-users-membership-with-team-is-now-pending: &602
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -39101,7 +39641,7 @@ paths:
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user
parameters:
- *94
- - *204
+ - *207
- *132
responses:
'204':
@@ -39128,7 +39668,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#list-team-projects
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -39138,7 +39678,7 @@ paths:
application/json:
schema:
type: array
- items: &274
+ items: &277
title: Team Project
description: A team's access to a project.
type: object
@@ -39206,7 +39746,7 @@ paths:
- updated_at
- permissions
examples:
- default: &600
+ default: &603
value:
- owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -39270,8 +39810,8 @@ paths:
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project
parameters:
- *94
- - *204
- - &275
+ - *207
+ - &278
name: project_id
description: The unique identifier of the project.
in: path
@@ -39283,9 +39823,9 @@ paths:
description: Response
content:
application/json:
- schema: *274
+ schema: *277
examples:
- default: &601
+ default: &604
value:
owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -39348,8 +39888,8 @@ paths:
url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions
parameters:
- *94
- - *204
- - *275
+ - *207
+ - *278
requestBody:
required: false
content:
@@ -39416,8 +39956,8 @@ paths:
url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team
parameters:
- *94
- - *204
- - *275
+ - *207
+ - *278
responses:
'204':
description: Response
@@ -39445,7 +39985,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#list-team-repositories
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -39457,7 +39997,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -39487,15 +40027,15 @@ paths:
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository
parameters:
- *94
- - *204
- - *276
- - *277
+ - *207
+ - *279
+ - *280
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &602
+ schema: &605
title: Team Repository
description: A team's access to a repository.
type: object
@@ -40065,9 +40605,9 @@ paths:
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions
parameters:
- *94
- - *204
- - *276
- - *277
+ - *207
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -40113,9 +40653,9 @@ paths:
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team
parameters:
- *94
- - *204
- - *276
- - *277
+ - *207
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -40140,7 +40680,7 @@ paths:
url: https://docs.github.com/rest/teams/teams#list-child-teams
parameters:
- *94
- - *204
+ - *207
- *17
- *19
responses:
@@ -40150,9 +40690,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- response-if-child-teams-exist: &603
+ response-if-child-teams-exist: &606
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -40279,7 +40819,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#get-a-project-card
parameters:
- - &278
+ - &281
name: card_id
description: The unique identifier of the card.
in: path
@@ -40291,7 +40831,7 @@ paths:
description: Response
content:
application/json:
- schema: &279
+ schema: &282
title: Project Card
description: Project cards represent a scope of work.
type: object
@@ -40358,7 +40898,7 @@ paths:
- created_at
- updated_at
examples:
- default: &280
+ default: &283
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
@@ -40414,7 +40954,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card
parameters:
- - *278
+ - *281
requestBody:
required: false
content:
@@ -40441,9 +40981,9 @@ paths:
description: Response
content:
application/json:
- schema: *279
+ schema: *282
examples:
- default: *280
+ default: *283
'304': *37
'403': *29
'401': *25
@@ -40470,7 +41010,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#delete-a-project-card
parameters:
- - *278
+ - *281
responses:
'204':
description: Response
@@ -40514,7 +41054,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#move-a-project-card
parameters:
- - *278
+ - *281
requestBody:
required: true
content:
@@ -40625,7 +41165,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#get-a-project-column
parameters:
- - &281
+ - &284
name: column_id
description: The unique identifier of the column.
in: path
@@ -40637,7 +41177,7 @@ paths:
description: Response
content:
application/json:
- schema: &282
+ schema: &285
title: Project Column
description: Project columns contain cards of work.
type: object
@@ -40683,7 +41223,7 @@ paths:
- created_at
- updated_at
examples:
- default: &283
+ default: &286
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
@@ -40718,7 +41258,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column
parameters:
- - *281
+ - *284
requestBody:
required: true
content:
@@ -40742,9 +41282,9 @@ paths:
description: Response
content:
application/json:
- schema: *282
+ schema: *285
examples:
- default: *283
+ default: *286
'304': *37
'403': *29
'401': *25
@@ -40769,7 +41309,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#delete-a-project-column
parameters:
- - *281
+ - *284
responses:
'204':
description: Response
@@ -40798,7 +41338,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#list-project-cards
parameters:
- - *281
+ - *284
- name: archived_state
description: Filters the project cards that are returned by the card's state.
in: query
@@ -40819,7 +41359,7 @@ paths:
application/json:
schema:
type: array
- items: *279
+ items: *282
examples:
default:
value:
@@ -40878,7 +41418,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/cards#create-a-project-card
parameters:
- - *281
+ - *284
requestBody:
required: true
content:
@@ -40918,9 +41458,9 @@ paths:
description: Response
content:
application/json:
- schema: *279
+ schema: *282
examples:
- default: *280
+ default: *283
'304': *37
'403': *29
'401': *25
@@ -40976,7 +41516,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#move-a-project-column
parameters:
- - *281
+ - *284
requestBody:
required: true
content:
@@ -41036,15 +41576,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#get-a-project
parameters:
- - *275
+ - *278
responses:
'200':
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
- default: &284
+ default: &287
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
@@ -41101,7 +41641,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#update-a-project
parameters:
- - *275
+ - *278
requestBody:
required: false
content:
@@ -41147,9 +41687,9 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
- default: *284
+ default: *287
'404':
description: Not Found if the authenticated user does not have access to
the project
@@ -41170,7 +41710,7 @@ paths:
items:
type: string
'401': *25
- '410': *285
+ '410': *288
'422': *7
x-github:
githubCloudOnly: false
@@ -41193,7 +41733,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#delete-a-project
parameters:
- - *275
+ - *278
responses:
'204':
description: Delete Success
@@ -41214,7 +41754,7 @@ paths:
items:
type: string
'401': *25
- '410': *285
+ '410': *288
'404': *6
x-github:
githubCloudOnly: false
@@ -41238,7 +41778,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators
parameters:
- - *275
+ - *278
- 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
@@ -41265,7 +41805,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404': *6
@@ -41295,7 +41835,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator
parameters:
- - *275
+ - *278
- *132
requestBody:
required: false
@@ -41348,7 +41888,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator
parameters:
- - *275
+ - *278
- *132
responses:
'204':
@@ -41380,7 +41920,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user
parameters:
- - *275
+ - *278
- *132
responses:
'200':
@@ -41454,7 +41994,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#list-project-columns
parameters:
- - *275
+ - *278
- *17
- *19
responses:
@@ -41464,7 +42004,7 @@ paths:
application/json:
schema:
type: array
- items: *282
+ items: *285
examples:
default:
value:
@@ -41502,7 +42042,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/columns#create-a-project-column
parameters:
- - *275
+ - *278
requestBody:
required: true
content:
@@ -41525,7 +42065,7 @@ paths:
description: Response
content:
application/json:
- schema: *282
+ schema: *285
examples:
default:
value:
@@ -41589,7 +42129,7 @@ paths:
resources:
type: object
properties:
- core: &286
+ core: &289
title: Rate Limit
type: object
properties:
@@ -41606,20 +42146,20 @@ paths:
- remaining
- reset
- used
- graphql: *286
- search: *286
- code_search: *286
- source_import: *286
- integration_manifest: *286
- code_scanning_upload: *286
- actions_runner_registration: *286
- scim: *286
- dependency_snapshots: *286
- code_scanning_autofix: *286
+ graphql: *289
+ search: *289
+ code_search: *289
+ source_import: *289
+ integration_manifest: *289
+ code_scanning_upload: *289
+ actions_runner_registration: *289
+ scim: *289
+ dependency_snapshots: *289
+ code_scanning_autofix: *289
required:
- core
- search
- rate: *286
+ rate: *289
required:
- rate
- resources
@@ -41723,14 +42263,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
default-response:
summary: Default response
@@ -42231,7 +42771,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *288
+ '301': *291
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42249,8 +42789,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -42494,10 +43034,10 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
- '307': &290
+ default: *292
+ '307': &293
description: Temporary Redirect
content:
application/json:
@@ -42526,8 +43066,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -42549,7 +43089,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *290
+ '307': *293
'404': *6
x-github:
githubCloudOnly: false
@@ -42572,11 +43112,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- - &316
+ - &319
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -42599,7 +43139,7 @@ paths:
type: integer
artifacts:
type: array
- items: &291
+ items: &294
title: Artifact
description: An artifact
type: object
@@ -42677,7 +43217,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &317
+ default: &320
value:
total_count: 2
artifacts:
@@ -42738,9 +43278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *276
- - *277
- - &292
+ - *279
+ - *280
+ - &295
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -42752,7 +43292,7 @@ paths:
description: Response
content:
application/json:
- schema: *291
+ schema: *294
examples:
default:
value:
@@ -42790,9 +43330,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *276
- - *277
- - *292
+ - *279
+ - *280
+ - *295
responses:
'204':
description: Response
@@ -42816,9 +43356,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *276
- - *277
- - *292
+ - *279
+ - *280
+ - *295
- name: archive_format
in: path
required: true
@@ -42832,7 +43372,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': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42855,14 +43395,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *293
+ schema: *296
examples:
default:
value:
@@ -42888,11 +43428,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- - &294
+ - &297
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/<branch name>`. To reference
@@ -42926,7 +43466,7 @@ paths:
description: Response
content:
application/json:
- schema: &295
+ schema: &298
title: Repository actions caches
description: Repository actions caches
type: object
@@ -42968,7 +43508,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &296
+ default: &299
value:
total_count: 1
actions_caches:
@@ -43000,23 +43540,23 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *294
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *295
+ schema: *298
examples:
- default: *296
+ default: *299
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -43036,8 +43576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -43068,9 +43608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *276
- - *277
- - &297
+ - *279
+ - *280
+ - &300
name: job_id
description: The unique identifier of the job.
in: path
@@ -43082,7 +43622,7 @@ paths:
description: Response
content:
application/json:
- schema: &320
+ schema: &323
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -43389,9 +43929,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *276
- - *277
- - *297
+ - *279
+ - *280
+ - *300
responses:
'302':
description: Response
@@ -43419,9 +43959,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *276
- - *277
- - *297
+ - *279
+ - *280
+ - *300
requestBody:
required: false
content:
@@ -43466,8 +44006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Status response
@@ -43517,8 +44057,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -43581,8 +44121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -43600,7 +44140,7 @@ paths:
type: integer
secrets:
type: array
- items: &322
+ items: &325
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -43620,7 +44160,7 @@ paths:
- created_at
- updated_at
examples:
- default: &323
+ default: &326
value:
total_count: 2
secrets:
@@ -43653,9 +44193,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *276
- - *277
- - *298
+ - *279
+ - *280
+ - *301
- *19
responses:
'200':
@@ -43672,7 +44212,7 @@ paths:
type: integer
variables:
type: array
- items: &326
+ items: &329
title: Actions Variable
type: object
properties:
@@ -43702,7 +44242,7 @@ paths:
- created_at
- updated_at
examples:
- default: &327
+ default: &330
value:
total_count: 2
variables:
@@ -43735,8 +44275,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -43745,11 +44285,11 @@ paths:
schema:
type: object
properties:
- enabled: &300
+ enabled: &303
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *108
- selected_actions_url: *299
+ selected_actions_url: *302
required:
- enabled
examples:
@@ -43776,8 +44316,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -43788,7 +44328,7 @@ paths:
schema:
type: object
properties:
- enabled: *300
+ enabled: *303
allowed_actions: *108
required:
- enabled
@@ -43818,14 +44358,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: &301
+ schema: &304
type: object
properties:
access_level:
@@ -43842,7 +44382,7 @@ paths:
required:
- access_level
examples:
- default: &302
+ default: &305
value:
access_level: organization
x-github:
@@ -43866,15 +44406,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
application/json:
- schema: *301
+ schema: *304
examples:
- default: *302
+ default: *305
responses:
'204':
description: Response
@@ -43898,8 +44438,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -43926,8 +44466,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -43959,14 +44499,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *303
+ schema: *306
examples:
default: *114
x-github:
@@ -43989,8 +44529,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Success response
@@ -44001,7 +44541,7 @@ paths:
required: true
content:
application/json:
- schema: *304
+ schema: *307
examples:
default: *114
x-github:
@@ -44030,8 +44570,8 @@ paths:
in: query
schema:
type: string
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -44075,8 +44615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -44084,9 +44624,9 @@ paths:
application/json:
schema:
type: array
- items: *305
+ items: *308
examples:
- default: *306
+ default: *309
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44108,8 +44648,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -44152,7 +44692,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *307
+ '201': *310
'404': *6
'422': *7
'409': *46
@@ -44183,8 +44723,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'201':
description: Response
@@ -44192,7 +44732,7 @@ paths:
application/json:
schema: *123
examples:
- default: *308
+ default: *311
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44220,8 +44760,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'201':
description: Response
@@ -44229,7 +44769,7 @@ paths:
application/json:
schema: *123
examples:
- default: *309
+ default: *312
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44251,8 +44791,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
'200':
@@ -44261,7 +44801,7 @@ paths:
application/json:
schema: *121
examples:
- default: *310
+ default: *313
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44282,8 +44822,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
'204':
@@ -44309,8 +44849,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
'200': *125
@@ -44335,8 +44875,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
requestBody:
required: true
@@ -44385,8 +44925,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
requestBody:
required: true
@@ -44436,11 +44976,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
responses:
- '200': *311
+ '200': *314
'404': *6
x-github:
githubCloudOnly: false
@@ -44467,10 +45007,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *120
- - *312
+ - *315
responses:
'200': *125
'404': *6
@@ -44498,9 +45038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *276
- - *277
- - &330
+ - *279
+ - *280
+ - &333
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.
@@ -44508,7 +45048,7 @@ paths:
required: false
schema:
type: string
- - &331
+ - &334
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -44516,7 +45056,7 @@ paths:
required: false
schema:
type: string
- - &332
+ - &335
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -44525,7 +45065,7 @@ paths:
required: false
schema:
type: string
- - &333
+ - &336
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
@@ -44552,7 +45092,7 @@ paths:
- pending
- *17
- *19
- - &334
+ - &337
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/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -44561,7 +45101,7 @@ paths:
schema:
type: string
format: date-time
- - &313
+ - &316
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -44570,13 +45110,13 @@ paths:
schema:
type: boolean
default: false
- - &335
+ - &338
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &336
+ - &339
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -44599,7 +45139,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &314
+ items: &317
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -44694,7 +45234,7 @@ paths:
that triggered the run.
type: array
nullable: true
- items: &355
+ items: &358
title: Pull Request Minimal
type: object
properties:
@@ -44813,7 +45353,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &359
+ properties: &362
id:
type: string
description: SHA for the commit
@@ -44864,7 +45404,7 @@ paths:
- name
- email
nullable: true
- required: &360
+ required: &363
- id
- tree_id
- message
@@ -44911,7 +45451,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &337
+ default: &340
value:
total_count: 1
workflow_runs:
@@ -45147,24 +45687,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *276
- - *277
- - &315
+ - *279
+ - *280
+ - &318
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *313
+ - *316
responses:
'200':
description: Response
content:
application/json:
- schema: *314
+ schema: *317
examples:
- default: &318
+ default: &321
value:
id: 30433642
name: Build
@@ -45405,9 +45945,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'204':
description: Response
@@ -45430,9 +45970,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'200':
description: Response
@@ -45551,9 +46091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'201':
description: Response
@@ -45586,12 +46126,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
- *17
- *19
- - *316
+ - *319
responses:
'200':
description: Response
@@ -45607,9 +46147,9 @@ paths:
type: integer
artifacts:
type: array
- items: *291
+ items: *294
examples:
- default: *317
+ default: *320
headers:
Link: *58
x-github:
@@ -45633,25 +46173,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *276
- - *277
- - *315
- - &319
+ - *279
+ - *280
+ - *318
+ - &322
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *313
+ - *316
responses:
'200':
description: Response
content:
application/json:
- schema: *314
+ schema: *317
examples:
- default: *318
+ default: *321
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -45674,10 +46214,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *276
- - *277
- - *315
- - *319
+ - *279
+ - *280
+ - *318
+ - *322
- *17
- *19
responses:
@@ -45695,9 +46235,9 @@ paths:
type: integer
jobs:
type: array
- items: *320
+ items: *323
examples:
- default: &321
+ default: &324
value:
total_count: 1
jobs:
@@ -45810,10 +46350,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *276
- - *277
- - *315
- - *319
+ - *279
+ - *280
+ - *318
+ - *322
responses:
'302':
description: Response
@@ -45841,9 +46381,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'202':
description: Response
@@ -45876,9 +46416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: true
content:
@@ -45945,9 +46485,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'202':
description: Response
@@ -45980,9 +46520,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
- 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
@@ -46012,9 +46552,9 @@ paths:
type: integer
jobs:
type: array
- items: *320
+ items: *323
examples:
- default: *321
+ default: *324
headers:
Link: *58
x-github:
@@ -46039,9 +46579,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'302':
description: Response
@@ -46068,14 +46608,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'204':
description: Response
'403': *29
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46097,9 +46637,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'200':
description: Response
@@ -46159,7 +46699,7 @@ paths:
items:
type: object
properties:
- type: &439
+ type: &442
type: string
description: The type of reviewer.
enum:
@@ -46169,7 +46709,7 @@ paths:
reviewer:
anyOf:
- *4
- - *188
+ - *152
required:
- environment
- wait_timer
@@ -46244,9 +46784,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: true
content:
@@ -46293,7 +46833,7 @@ paths:
application/json:
schema:
type: array
- items: &434
+ items: &437
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -46399,7 +46939,7 @@ paths:
- created_at
- updated_at
examples:
- default: &435
+ default: &438
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -46455,9 +46995,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: false
content:
@@ -46501,9 +47041,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
requestBody:
required: false
content:
@@ -46556,9 +47096,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *276
- - *277
- - *315
+ - *279
+ - *280
+ - *318
responses:
'200':
description: Response
@@ -46695,8 +47235,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -46714,9 +47254,9 @@ paths:
type: integer
secrets:
type: array
- items: *322
+ items: *325
examples:
- default: *323
+ default: *326
headers:
Link: *58
x-github:
@@ -46741,16 +47281,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *324
+ schema: *327
examples:
- default: *325
+ default: *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46772,17 +47312,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *322
+ schema: *325
examples:
- default: &452
+ default: &455
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -46808,8 +47348,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
requestBody:
required: true
@@ -46867,8 +47407,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'204':
@@ -46894,9 +47434,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *276
- - *277
- - *298
+ - *279
+ - *280
+ - *301
- *19
responses:
'200':
@@ -46913,9 +47453,9 @@ paths:
type: integer
variables:
type: array
- items: *326
+ items: *329
examples:
- default: *327
+ default: *330
headers:
Link: *58
x-github:
@@ -46938,8 +47478,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -46991,17 +47531,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
responses:
'200':
description: Response
content:
application/json:
- schema: *326
+ schema: *329
examples:
- default: &453
+ default: &456
value:
name: USERNAME
value: octocat
@@ -47027,8 +47567,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
requestBody:
required: true
@@ -47071,8 +47611,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
responses:
'204':
@@ -47098,8 +47638,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -47117,7 +47657,7 @@ paths:
type: integer
workflows:
type: array
- items: &328
+ items: &331
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -47224,9 +47764,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *276
- - *277
- - &329
+ - *279
+ - *280
+ - &332
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -47241,7 +47781,7 @@ paths:
description: Response
content:
application/json:
- schema: *328
+ schema: *331
examples:
default:
value:
@@ -47274,9 +47814,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'204':
description: Response
@@ -47301,9 +47841,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'204':
description: Response
@@ -47354,9 +47894,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'204':
description: Response
@@ -47383,19 +47923,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *276
- - *277
- - *329
- - *330
- - *331
+ - *279
+ - *280
- *332
- *333
- - *17
- - *19
- *334
- - *313
- *335
- *336
+ - *17
+ - *19
+ - *337
+ - *316
+ - *338
+ - *339
responses:
'200':
description: Response
@@ -47411,9 +47951,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *314
+ items: *317
examples:
- default: *337
+ default: *340
headers:
Link: *58
x-github:
@@ -47445,9 +47985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *276
- - *277
- - *329
+ - *279
+ - *280
+ - *332
responses:
'200':
description: Response
@@ -47508,8 +48048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *48
- *17
- *39
@@ -47673,8 +48213,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -47686,7 +48226,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404': *6
@@ -47711,8 +48251,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: assignee
in: path
required: true
@@ -47748,8 +48288,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-an-attestation
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -47861,8 +48401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-attestations
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *39
- *40
@@ -47916,7 +48456,7 @@ paths:
bundle_url:
type: string
examples:
- default: *338
+ default: *341
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -47936,8 +48476,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -47945,7 +48485,7 @@ paths:
application/json:
schema:
type: array
- items: &339
+ items: &342
title: Autolink reference
description: An autolink reference.
type: object
@@ -47995,8 +48535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -48035,9 +48575,9 @@ paths:
description: response
content:
application/json:
- schema: *339
+ schema: *342
examples:
- default: &340
+ default: &343
value:
id: 1
key_prefix: TICKET-
@@ -48068,9 +48608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *276
- - *277
- - &341
+ - *279
+ - *280
+ - &344
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -48082,9 +48622,9 @@ paths:
description: Response
content:
application/json:
- schema: *339
+ schema: *342
examples:
- default: *340
+ default: *343
'404': *6
x-github:
githubCloudOnly: false
@@ -48104,9 +48644,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *276
- - *277
- - *341
+ - *279
+ - *280
+ - *344
responses:
'204':
description: Response
@@ -48130,8 +48670,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response if Dependabot is enabled
@@ -48179,8 +48719,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -48201,8 +48741,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -48222,8 +48762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -48261,7 +48801,7 @@ paths:
- url
protected:
type: boolean
- protection: &343
+ protection: &346
title: Branch Protection
description: Branch Protection
type: object
@@ -48303,7 +48843,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &346
+ enforce_admins: &349
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -48318,7 +48858,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &348
+ required_pull_request_reviews: &351
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -48339,7 +48879,7 @@ paths:
description: The list of teams with review dismissal
access.
type: array
- items: *188
+ items: *152
apps:
description: The list of apps with review dismissal
access.
@@ -48368,7 +48908,7 @@ paths:
description: The list of teams allowed to bypass
pull request requirements.
type: array
- items: *188
+ items: *152
apps:
description: The list of apps allowed to bypass
pull request requirements.
@@ -48394,7 +48934,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &345
+ restrictions: &348
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -48701,9 +49241,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *276
- - *277
- - &344
+ - *279
+ - *280
+ - &347
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/graphql).
@@ -48717,14 +49257,14 @@ paths:
description: Response
content:
application/json:
- schema: &354
+ schema: &357
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &407
+ commit: &410
title: Commit
description: Commit
type: object
@@ -48758,7 +49298,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &342
+ properties: &345
name:
type: string
example: '"Chris Wanstrath"'
@@ -48773,7 +49313,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *342
+ properties: *345
nullable: true
message:
type: string
@@ -48794,7 +49334,7 @@ paths:
required:
- sha
- url
- verification: &459
+ verification: &462
title: Verification
type: object
properties:
@@ -48864,7 +49404,7 @@ paths:
type: integer
files:
type: array
- items: &422
+ items: &425
title: Diff Entry
description: Diff Entry
type: object
@@ -48947,7 +49487,7 @@ paths:
- self
protected:
type: boolean
- protection: *343
+ protection: *346
protection_url:
type: string
format: uri
@@ -49054,7 +49594,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *288
+ '301': *291
'404': *6
x-github:
githubCloudOnly: false
@@ -49076,15 +49616,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *346
examples:
default:
value:
@@ -49278,9 +49818,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -49535,7 +50075,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &351
+ required_status_checks: &354
title: Status Check Policy
description: Status Check Policy
type: object
@@ -49611,7 +50151,7 @@ paths:
items: *4
teams:
type: array
- items: *188
+ items: *152
apps:
type: array
items: *5
@@ -49629,7 +50169,7 @@ paths:
items: *4
teams:
type: array
- items: *188
+ items: *152
apps:
type: array
items: *5
@@ -49687,7 +50227,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *345
+ restrictions: *348
required_conversation_resolution:
type: object
properties:
@@ -49799,9 +50339,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -49826,17 +50366,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: &347
+ default: &350
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -49858,17 +50398,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: *347
+ default: *350
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -49887,9 +50427,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -49914,17 +50454,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *348
+ schema: *351
examples:
- default: &349
+ default: &352
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -50020,9 +50560,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50120,9 +50660,9 @@ paths:
description: Response
content:
application/json:
- schema: *348
+ schema: *351
examples:
- default: *349
+ default: *352
'422': *15
x-github:
githubCloudOnly: false
@@ -50143,9 +50683,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50172,17 +50712,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: &350
+ default: &353
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -50205,17 +50745,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *346
+ schema: *349
examples:
- default: *350
+ default: *353
'404': *6
x-github:
githubCloudOnly: false
@@ -50235,9 +50775,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50262,17 +50802,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *354
examples:
- default: &352
+ default: &355
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -50298,9 +50838,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50352,9 +50892,9 @@ paths:
description: Response
content:
application/json:
- schema: *351
+ schema: *354
examples:
- default: *352
+ default: *355
'404': *6
'422': *15
x-github:
@@ -50376,9 +50916,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50402,9 +50942,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -50438,9 +50978,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50507,9 +51047,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -50573,9 +51113,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
content:
application/json:
@@ -50641,15 +51181,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
content:
application/json:
- schema: *345
+ schema: *348
examples:
default:
value:
@@ -50740,9 +51280,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'204':
description: Response
@@ -50765,9 +51305,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -50777,7 +51317,7 @@ paths:
type: array
items: *5
examples:
- default: &353
+ default: &356
value:
- id: 1
slug: octoapp
@@ -50834,9 +51374,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -50870,7 +51410,7 @@ paths:
type: array
items: *5
examples:
- default: *353
+ default: *356
'422': *15
x-github:
githubCloudOnly: false
@@ -50891,9 +51431,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -50927,7 +51467,7 @@ paths:
type: array
items: *5
examples:
- default: *353
+ default: *356
'422': *15
x-github:
githubCloudOnly: false
@@ -50948,9 +51488,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -50984,7 +51524,7 @@ paths:
type: array
items: *5
examples:
- default: *353
+ default: *356
'422': *15
x-github:
githubCloudOnly: false
@@ -51006,9 +51546,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -51016,9 +51556,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'404': *6
x-github:
githubCloudOnly: false
@@ -51038,9 +51578,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -51076,9 +51616,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'422': *15
x-github:
githubCloudOnly: false
@@ -51099,9 +51639,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: false
content:
@@ -51137,9 +51677,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'422': *15
x-github:
githubCloudOnly: false
@@ -51160,9 +51700,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
content:
application/json:
@@ -51197,9 +51737,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
'422': *15
x-github:
githubCloudOnly: false
@@ -51221,9 +51761,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
responses:
'200':
description: Response
@@ -51233,7 +51773,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'404': *6
x-github:
githubCloudOnly: false
@@ -51257,9 +51797,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51292,7 +51832,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'422': *15
x-github:
githubCloudOnly: false
@@ -51317,9 +51857,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51352,7 +51892,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'422': *15
x-github:
githubCloudOnly: false
@@ -51377,9 +51917,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51412,7 +51952,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'422': *15
x-github:
githubCloudOnly: false
@@ -51439,9 +51979,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
requestBody:
required: true
content:
@@ -51463,7 +52003,7 @@ paths:
description: Response
content:
application/json:
- schema: *354
+ schema: *357
examples:
default:
value:
@@ -51579,8 +52119,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -51859,7 +52399,7 @@ paths:
description: Response
content:
application/json:
- schema: &356
+ schema: &359
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -51978,8 +52518,8 @@ paths:
do not necessarily indicate pull requests that triggered the
check.
type: array
- items: *355
- deployment: &653
+ items: *358
+ deployment: &656
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -52259,9 +52799,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *276
- - *277
- - &357
+ - *279
+ - *280
+ - &360
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -52273,9 +52813,9 @@ paths:
description: Response
content:
application/json:
- schema: *356
+ schema: *359
examples:
- default: &358
+ default: &361
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -52375,9 +52915,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *276
- - *277
- - *357
+ - *279
+ - *280
+ - *360
requestBody:
required: true
content:
@@ -52617,9 +53157,9 @@ paths:
description: Response
content:
application/json:
- schema: *356
+ schema: *359
examples:
- default: *358
+ default: *361
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52639,9 +53179,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *276
- - *277
- - *357
+ - *279
+ - *280
+ - *360
- *17
- *19
responses:
@@ -52738,9 +53278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *276
- - *277
- - *357
+ - *279
+ - *280
+ - *360
responses:
'201':
description: Response
@@ -52784,8 +53324,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -52807,7 +53347,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &361
+ schema: &364
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -52871,7 +53411,7 @@ paths:
nullable: true
pull_requests:
type: array
- items: *355
+ items: *358
nullable: true
app:
title: GitHub app
@@ -52893,12 +53433,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &679
+ head_commit: &682
title: Simple Commit
description: A commit.
type: object
- properties: *359
- required: *360
+ properties: *362
+ required: *363
latest_check_runs_count:
type: integer
check_runs_url:
@@ -52926,7 +53466,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &362
+ default: &365
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -53217,9 +53757,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *361
+ schema: *364
examples:
- default: *362
+ default: *365
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53238,8 +53778,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -53548,9 +54088,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *276
- - *277
- - &363
+ - *279
+ - *280
+ - &366
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -53562,9 +54102,9 @@ paths:
description: Response
content:
application/json:
- schema: *361
+ schema: *364
examples:
- default: *362
+ default: *365
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53587,17 +54127,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *276
- - *277
- - *363
- - &415
+ - *279
+ - *280
+ - *366
+ - &418
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &416
+ - &419
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -53636,9 +54176,9 @@ paths:
type: integer
check_runs:
type: array
- items: *356
+ items: *359
examples:
- default: &417
+ default: &420
value:
total_count: 1
check_runs:
@@ -53740,9 +54280,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *276
- - *277
- - *363
+ - *279
+ - *280
+ - *366
responses:
'201':
description: Response
@@ -53775,21 +54315,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *276
- - *277
- - *364
- - *365
+ - *279
+ - *280
+ - *367
+ - *368
- *19
- *17
- - &382
+ - &385
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/<branch name>` or simply
`<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
in: query
required: false
- schema: *366
- - &383
+ schema: *369
+ - &386
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -53814,13 +54354,13 @@ paths:
be returned.
in: query
required: false
- schema: *367
+ schema: *370
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *368
+ schema: *371
responses:
'200':
description: Response
@@ -53833,12 +54373,12 @@ paths:
properties:
number: *54
created_at: *55
- updated_at: *133
+ updated_at: *136
url: *56
html_url: *57
- instances_url: *369
- state: *138
- fixed_at: *134
+ instances_url: *372
+ state: *141
+ fixed_at: *137
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -53846,12 +54386,12 @@ paths:
properties: *20
required: *21
nullable: true
- dismissed_at: *135
- dismissed_reason: *370
- dismissed_comment: *371
- rule: *372
- tool: *373
- most_recent_instance: *374
+ dismissed_at: *138
+ dismissed_reason: *373
+ dismissed_comment: *374
+ rule: *375
+ tool: *376
+ most_recent_instance: *377
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -53974,7 +54514,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &375
+ '403': &378
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -54001,9 +54541,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *276
- - *277
- - &376
+ - *279
+ - *280
+ - &379
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -54017,17 +54557,17 @@ paths:
description: Response
content:
application/json:
- schema: &377
+ schema: &380
type: object
properties:
number: *54
created_at: *55
- updated_at: *133
+ updated_at: *136
url: *56
html_url: *57
- instances_url: *369
- state: *138
- fixed_at: *134
+ instances_url: *372
+ state: *141
+ fixed_at: *137
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -54035,9 +54575,9 @@ paths:
properties: *20
required: *21
nullable: true
- dismissed_at: *135
- dismissed_reason: *370
- dismissed_comment: *371
+ dismissed_at: *138
+ dismissed_reason: *373
+ dismissed_comment: *374
rule:
type: object
properties:
@@ -54091,8 +54631,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *373
- most_recent_instance: *374
+ tool: *376
+ most_recent_instance: *377
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -54188,7 +54728,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54208,9 +54748,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
requestBody:
required: true
content:
@@ -54225,8 +54765,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *370
- dismissed_comment: *371
+ dismissed_reason: *373
+ dismissed_comment: *374
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -54245,7 +54785,7 @@ paths:
description: Response
content:
application/json:
- schema: *377
+ schema: *380
examples:
default:
value:
@@ -54321,7 +54861,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &381
+ '403': &384
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -54348,15 +54888,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
responses:
'200':
description: Response
content:
application/json:
- schema: &378
+ schema: &381
type: object
properties:
status:
@@ -54382,13 +54922,13 @@ paths:
- description
- started_at
examples:
- default: &379
+ default: &382
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &380
+ '400': &383
description: Bad Request
content:
application/json:
@@ -54399,7 +54939,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': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54424,29 +54964,29 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
responses:
'200':
description: OK
content:
application/json:
- schema: *378
+ schema: *381
examples:
- default: *379
+ default: *382
'202':
description: Accepted
content:
application/json:
- schema: *378
+ schema: *381
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *380
+ '400': *383
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -54478,9 +55018,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
requestBody:
required: false
content:
@@ -54525,8 +55065,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *380
- '403': *381
+ '400': *383
+ '403': *384
'404': *6
'422':
description: Unprocessable Entity
@@ -54550,13 +55090,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
- *19
- *17
- - *382
- - *383
+ - *385
+ - *386
responses:
'200':
description: Response
@@ -54564,7 +55104,7 @@ paths:
application/json:
schema:
type: array
- items: *374
+ items: *377
examples:
default:
value:
@@ -54603,7 +55143,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54637,25 +55177,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *276
- - *277
- - *364
- - *365
+ - *279
+ - *280
+ - *367
+ - *368
- *19
- *17
- - *383
+ - *386
- 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/<branch name>` or simply
`<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
required: false
- schema: *366
+ schema: *369
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &386
+ schema: &389
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -54676,23 +55216,23 @@ paths:
application/json:
schema:
type: array
- items: &387
+ items: &390
type: object
properties:
- ref: *366
- commit_sha: &395
+ ref: *369
+ commit_sha: &398
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: *384
+ analysis_key: *387
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *385
+ category: *388
error:
type: string
example: error reading field xyz
@@ -54716,8 +55256,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *386
- tool: *373
+ sarif_id: *389
+ tool: *376
deletable:
type: boolean
warning:
@@ -54778,7 +55318,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54814,8 +55354,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -54828,7 +55368,7 @@ paths:
description: Response
content:
application/json:
- schema: *387
+ schema: *390
examples:
response:
summary: application/json response
@@ -54882,7 +55422,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -54964,8 +55504,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -55018,7 +55558,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': *381
+ '403': *384
'404': *6
'503': *65
x-github:
@@ -55040,8 +55580,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -55049,7 +55589,7 @@ paths:
application/json:
schema:
type: array
- items: &388
+ items: &391
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -55160,7 +55700,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': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -55189,8 +55729,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: language
in: path
description: The language of the CodeQL database.
@@ -55202,7 +55742,7 @@ paths:
description: Response
content:
application/json:
- schema: *388
+ schema: *391
examples:
default:
value:
@@ -55234,9 +55774,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': &424
+ '302': &427
description: Found
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -55258,8 +55798,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: language
in: path
description: The language of the CodeQL database.
@@ -55269,7 +55809,7 @@ paths:
responses:
'204':
description: Response
- '403': *381
+ '403': *384
'404': *6
'503': *65
x-github:
@@ -55297,8 +55837,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -55307,7 +55847,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &389
+ language: &392
type: string
description: The language targeted by the CodeQL query
enum:
@@ -55386,7 +55926,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &393
+ schema: &396
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -55396,7 +55936,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *53
actor: *4
- query_language: *389
+ query_language: *392
query_pack_url:
type: string
description: The download url for the query pack.
@@ -55443,7 +55983,7 @@ paths:
items:
type: object
properties:
- repository: &390
+ repository: &393
title: Repository Identifier
description: Repository Identifier
type: object
@@ -55479,7 +56019,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &394
+ analysis_status: &397
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -55511,7 +56051,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &391
+ access_mismatch_repos: &394
type: object
properties:
repository_count:
@@ -55525,7 +56065,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: *390
+ items: *393
required:
- repository_count
- repositories
@@ -55547,8 +56087,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *391
- over_limit_repos: *391
+ no_codeql_db_repos: *394
+ over_limit_repos: *394
required:
- access_mismatch_repos
- not_found_repos
@@ -55564,7 +56104,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &392
+ value: &395
summary: Default response
value:
id: 1
@@ -55716,10 +56256,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *392
+ value: *395
repository_lists:
summary: Response for a successful variant analysis submission
- value: *392
+ value: *395
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -55747,8 +56287,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -55760,9 +56300,9 @@ paths:
description: Response
content:
application/json:
- schema: *393
+ schema: *396
examples:
- default: *392
+ default: *395
'404': *6
'503': *65
x-github:
@@ -55785,7 +56325,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis
parameters:
- - *276
+ - *279
- name: repo
in: path
description: The name of the controller repository.
@@ -55820,7 +56360,7 @@ paths:
type: object
properties:
repository: *53
- analysis_status: *394
+ analysis_status: *397
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -55945,8 +56485,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -56020,7 +56560,7 @@ paths:
query_suite: default
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *375
+ '403': *378
'404': *6
'503': *65
x-github:
@@ -56041,8 +56581,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -56124,7 +56664,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *381
+ '403': *384
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -56189,8 +56729,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -56198,7 +56738,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *395
+ commit_sha: *398
ref:
type: string
description: |-
@@ -56256,7 +56796,7 @@ paths:
schema:
type: object
properties:
- id: *386
+ id: *389
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -56270,7 +56810,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': *381
+ '403': *384
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -56293,8 +56833,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -56340,7 +56880,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': *375
+ '403': *378
'404':
description: Not Found if the sarif id does not match any upload
'503': *65
@@ -56365,8 +56905,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -56422,7 +56962,7 @@ paths:
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325
created_at: '2024-05-01T00:00:00Z'
updated_at: '2024-05-01T00:00:00Z'
- '204': *142
+ '204': *145
'304': *37
'403': *29
'404': *6
@@ -56447,8 +56987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -56568,8 +57108,8 @@ paths:
parameters:
- *17
- *19
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -56585,7 +57125,7 @@ paths:
type: integer
codespaces:
type: array
- items: *195
+ items: *198
examples:
default:
value:
@@ -56861,7 +57401,7 @@ paths:
start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start
stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop
recent_folders: []
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -56883,8 +57423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -56947,17 +57487,17 @@ paths:
description: Response when the codespace was successfully created
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'400': *14
'401': *25
'403': *29
@@ -56986,8 +57526,8 @@ paths:
parameters:
- *17
- *19
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -57027,7 +57567,7 @@ paths:
- path: ".devcontainer.json"
display_name: Default project configuration
total_count: 3
- '500': *145
+ '500': *148
'400': *14
'401': *25
'403': *29
@@ -57051,8 +57591,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -57087,14 +57627,14 @@ paths:
type: integer
machines:
type: array
- items: &610
+ items: &613
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *397
- required: *398
+ properties: *400
+ required: *401
examples:
- default: &611
+ default: &614
value:
total_count: 2
machines:
@@ -57111,7 +57651,7 @@ paths:
memory_in_bytes: 34359738368
cpus: 8
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -57134,8 +57674,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -57219,8 +57759,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -57286,8 +57826,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -57305,7 +57845,7 @@ paths:
type: integer
secrets:
type: array
- items: &402
+ items: &405
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -57325,7 +57865,7 @@ paths:
- created_at
- updated_at
examples:
- default: *399
+ default: *402
headers:
Link: *58
x-github:
@@ -57348,16 +57888,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *400
+ schema: *403
examples:
- default: *401
+ default: *404
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -57377,17 +57917,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *402
+ schema: *405
examples:
- default: *403
+ default: *406
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57407,8 +57947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
requestBody:
required: true
@@ -57461,8 +58001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'204':
@@ -57491,8 +58031,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -57534,7 +58074,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &404
+ properties: &407
login:
type: string
example: octocat
@@ -57627,7 +58167,7 @@ paths:
user_view_type:
type: string
example: public
- required: &405
+ required: &408
- avatar_url
- events_url
- followers_url
@@ -57701,8 +58241,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
responses:
'204':
@@ -57745,8 +58285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
requestBody:
required: false
@@ -57773,7 +58313,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &472
+ schema: &475
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -57995,8 +58535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
responses:
'204':
@@ -58026,8 +58566,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *132
responses:
'200':
@@ -58048,8 +58588,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *404
- required: *405
+ properties: *407
+ required: *408
nullable: true
required:
- permission
@@ -58104,8 +58644,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -58115,7 +58655,7 @@ paths:
application/json:
schema:
type: array
- items: &406
+ items: &409
title: Commit Comment
description: Commit Comment
type: object
@@ -58173,7 +58713,7 @@ paths:
- created_at
- updated_at
examples:
- default: &409
+ default: &412
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -58232,17 +58772,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'200':
description: Response
content:
application/json:
- schema: *406
+ schema: *409
examples:
- default: &410
+ default: &413
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -58299,8 +58839,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -58323,7 +58863,7 @@ paths:
description: Response
content:
application/json:
- schema: *406
+ schema: *409
examples:
default:
value:
@@ -58374,8 +58914,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'204':
@@ -58397,8 +58937,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -58425,9 +58965,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -58448,8 +58988,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -58482,16 +59022,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -58513,10 +59053,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- - *272
+ - *275
responses:
'204':
description: Response
@@ -58565,8 +59105,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -58622,9 +59162,9 @@ paths:
application/json:
schema:
type: array
- items: *407
+ items: *410
examples:
- default: &523
+ default: &526
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -58695,7 +59235,7 @@ paths:
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
headers:
Link: *58
- '500': *145
+ '500': *148
'400': *14
'404': *6
'409': *46
@@ -58718,9 +59258,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *276
- - *277
- - &408
+ - *279
+ - *280
+ - &411
name: commit_sha
description: The SHA of the commit.
in: path
@@ -58792,9 +59332,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
- *17
- *19
responses:
@@ -58804,9 +59344,9 @@ paths:
application/json:
schema:
type: array
- items: *406
+ items: *409
examples:
- default: *409
+ default: *412
headers:
Link: *58
x-github:
@@ -58834,9 +59374,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
requestBody:
required: true
content:
@@ -58871,9 +59411,9 @@ paths:
description: Response
content:
application/json:
- schema: *406
+ schema: *409
examples:
- default: *410
+ default: *413
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -58901,9 +59441,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
- *17
- *19
responses:
@@ -58913,7 +59453,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &517
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -59019,8 +59559,8 @@ paths:
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
nullable: true
active_lock_reason:
type: string
@@ -59065,7 +59605,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *188
+ items: *152
nullable: true
head:
type: object
@@ -59116,7 +59656,7 @@ paths:
_links:
type: object
properties:
- comments: &413
+ comments: &416
title: Link
description: Hypermedia Link
type: object
@@ -59125,13 +59665,13 @@ paths:
type: string
required:
- href
- commits: *413
- statuses: *413
- html: *413
- issue: *413
- review_comments: *413
- review_comment: *413
- self: *413
+ commits: *416
+ statuses: *416
+ html: *416
+ issue: *416
+ review_comments: *416
+ review_comment: *416
+ self: *416
required:
- comments
- commits
@@ -59142,7 +59682,7 @@ paths:
- review_comment
- self
author_association: *63
- auto_merge: &516
+ auto_merge: &519
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -59205,7 +59745,7 @@ paths:
- author_association
- auto_merge
examples:
- default: &515
+ default: &518
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -59742,11 +60282,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *19
- *17
- - &414
+ - &417
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)"
@@ -59761,9 +60301,9 @@ paths:
description: Response
content:
application/json:
- schema: *407
+ schema: *410
examples:
- default: &501
+ default: &504
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -59849,7 +60389,7 @@ paths:
.....
'422': *15
'404': *6
- '500': *145
+ '500': *148
'503': *65
'409': *46
x-github:
@@ -59876,11 +60416,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *276
- - *277
- - *414
- - *415
- - *416
+ - *279
+ - *280
+ - *417
+ - *418
+ - *419
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -59914,9 +60454,9 @@ paths:
type: integer
check_runs:
type: array
- items: *356
+ items: *359
examples:
- default: *417
+ default: *420
headers:
Link: *58
x-github:
@@ -59941,9 +60481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *276
- - *277
- - *414
+ - *279
+ - *280
+ - *417
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -59951,7 +60491,7 @@ paths:
schema:
type: integer
example: 1
- - *415
+ - *418
- *17
- *19
responses:
@@ -59969,7 +60509,7 @@ paths:
type: integer
check_suites:
type: array
- items: *361
+ items: *364
examples:
default:
value:
@@ -60169,9 +60709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *276
- - *277
- - *414
+ - *279
+ - *280
+ - *417
- *17
- *19
responses:
@@ -60369,9 +60909,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *276
- - *277
- - *414
+ - *279
+ - *280
+ - *417
- *17
- *19
responses:
@@ -60381,7 +60921,7 @@ paths:
application/json:
schema:
type: array
- items: &584
+ items: &587
title: Status
description: The status of a commit.
type: object
@@ -60462,7 +61002,7 @@ paths:
site_admin: false
headers:
Link: *58
- '301': *288
+ '301': *291
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60490,8 +61030,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -60520,20 +61060,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *418
- required: *419
+ properties: *421
+ required: *422
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &420
+ properties: &423
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &421
+ required: &424
- url
- html_url
nullable: true
@@ -60547,26 +61087,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
readme:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *420
- required: *421
+ properties: *423
+ required: *424
nullable: true
required:
- code_of_conduct
@@ -60693,8 +61233,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *19
- *17
- name: basehead
@@ -60737,8 +61277,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *407
- merge_base_commit: *407
+ base_commit: *410
+ merge_base_commit: *410
status:
type: string
enum:
@@ -60758,10 +61298,10 @@ paths:
example: 6
commits:
type: array
- items: *407
+ items: *410
files:
type: array
- items: *422
+ items: *425
required:
- url
- html_url
@@ -61004,7 +61544,7 @@ paths:
patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@
module Test"
'404': *6
- '500': *145
+ '500': *148
'503': *65
x-github:
githubCloudOnly: false
@@ -61047,8 +61587,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: path
description: path parameter
in: path
@@ -61191,7 +61731,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &423
+ response-if-content-is-a-file: &426
summary: Response if content is a file
value:
type: file
@@ -61323,7 +61863,7 @@ paths:
- size
- type
- url
- - &528
+ - &531
title: Content File
description: Content File
type: object
@@ -61524,7 +62064,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *423
+ response-if-content-is-a-file: *426
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -61593,7 +62133,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *424
+ '302': *427
'304': *37
x-github:
githubCloudOnly: false
@@ -61616,8 +62156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: path
description: path parameter
in: path
@@ -61710,7 +62250,7 @@ paths:
description: Response
content:
application/json:
- schema: &425
+ schema: &428
title: File Commit
description: File Commit
type: object
@@ -61862,7 +62402,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *428
examples:
example-for-creating-a-file:
value:
@@ -61916,7 +62456,7 @@ paths:
schema:
oneOf:
- *3
- - &454
+ - &457
description: Repository rule violation was detected
type: object
properties:
@@ -61937,7 +62477,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &576
+ placeholder_id: &579
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -61969,8 +62509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: path
description: path parameter
in: path
@@ -62031,7 +62571,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *428
examples:
default:
value:
@@ -62086,8 +62626,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -62210,21 +62750,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *276
- - *277
- - *149
- - *150
- - *151
- - *152
+ - *279
+ - *280
+ - *153
+ - *154
+ - *155
+ - *156
- name: manifest
in: query
description: A comma-separated list of full manifest paths. If specified,
only alerts for these manifests will be returned.
schema:
type: string
- - *153
- - *154
- - *155
+ - *157
+ - *158
+ - *159
- *48
- name: page
description: "**Closing down notice**. Page number of the results to fetch.
@@ -62244,8 +62784,8 @@ paths:
default: 30
- *39
- *40
- - *156
- - *157
+ - *160
+ - *161
responses:
'200':
description: Response
@@ -62253,7 +62793,7 @@ paths:
application/json:
schema:
type: array
- items: &428
+ items: &431
type: object
description: A Dependabot alert.
properties:
@@ -62299,13 +62839,13 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *426
+ security_advisory: *429
security_vulnerability: *52
url: *56
html_url: *57
created_at: *55
- updated_at: *133
- dismissed_at: *135
+ updated_at: *136
+ dismissed_at: *138
dismissed_by:
title: Simple User
description: A GitHub user.
@@ -62329,8 +62869,8 @@ paths:
dismissal.
nullable: true
maxLength: 280
- fixed_at: *134
- auto_dismissed_at: *427
+ fixed_at: *137
+ auto_dismissed_at: *430
required:
- number
- state
@@ -62560,9 +63100,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *276
- - *277
- - &429
+ - *279
+ - *280
+ - &432
name: alert_number
in: path
description: |-
@@ -62577,7 +63117,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *431
examples:
default:
value:
@@ -62690,9 +63230,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *276
- - *277
- - *429
+ - *279
+ - *280
+ - *432
requestBody:
required: true
content:
@@ -62737,7 +63277,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *431
examples:
default:
value:
@@ -62866,8 +63406,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -62885,7 +63425,7 @@ paths:
type: integer
secrets:
type: array
- items: &432
+ items: &435
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -62938,16 +63478,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *430
+ schema: *433
examples:
- default: *431
+ default: *434
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62967,15 +63507,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *432
+ schema: *435
examples:
default:
value:
@@ -63001,8 +63541,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
requestBody:
required: true
@@ -63055,8 +63595,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *127
responses:
'204':
@@ -63079,8 +63619,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -63240,8 +63780,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -63480,8 +64020,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -63556,7 +64096,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &433
+ metadata: &436
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -63589,7 +64129,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *433
+ metadata: *436
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -63602,7 +64142,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *433
+ metadata: *436
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -63731,8 +64271,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -63772,9 +64312,9 @@ paths:
application/json:
schema:
type: array
- items: *434
+ items: *437
examples:
- default: *435
+ default: *438
headers:
Link: *58
x-github:
@@ -63840,8 +64380,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -63922,7 +64462,7 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *437
examples:
simple-example:
summary: Simple example
@@ -63995,9 +64535,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *276
- - *277
- - &436
+ - *279
+ - *280
+ - &439
name: deployment_id
description: deployment_id parameter
in: path
@@ -64009,7 +64549,7 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *437
examples:
default:
value:
@@ -64074,9 +64614,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
responses:
'204':
description: Response
@@ -64098,9 +64638,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
- *17
- *19
responses:
@@ -64110,7 +64650,7 @@ paths:
application/json:
schema:
type: array
- items: &437
+ items: &440
title: Deployment Status
description: The status of a deployment.
type: object
@@ -64271,9 +64811,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
requestBody:
required: true
content:
@@ -64348,9 +64888,9 @@ paths:
description: Response
content:
application/json:
- schema: *437
+ schema: *440
examples:
- default: &438
+ default: &441
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -64406,9 +64946,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *276
- - *277
- - *436
+ - *279
+ - *280
+ - *439
- name: status_id
in: path
required: true
@@ -64419,9 +64959,9 @@ paths:
description: Response
content:
application/json:
- schema: *437
+ schema: *440
examples:
- default: *438
+ default: *441
'404': *6
x-github:
githubCloudOnly: false
@@ -64446,8 +64986,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -64504,8 +65044,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -64522,7 +65062,7 @@ paths:
type: integer
environments:
type: array
- items: &440
+ items: &443
title: Environment
description: Details of a deployment environment
type: object
@@ -64574,7 +65114,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &442
+ wait_timer: &445
type: integer
example: 30
description: The amount of time to delay a job after
@@ -64611,11 +65151,11 @@ paths:
items:
type: object
properties:
- type: *439
+ type: *442
reviewer:
anyOf:
- *4
- - *188
+ - *152
required:
- id
- node_id
@@ -64635,7 +65175,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &443
+ deployment_branch_policy: &446
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -64751,9 +65291,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *276
- - *277
- - &441
+ - *279
+ - *280
+ - &444
name: environment_name
in: path
required: true
@@ -64766,9 +65306,9 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *443
examples:
- default: &444
+ default: &447
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -64852,9 +65392,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
requestBody:
required: false
content:
@@ -64863,7 +65403,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *442
+ wait_timer: *445
prevent_self_review:
type: boolean
example: false
@@ -64880,13 +65420,13 @@ paths:
items:
type: object
properties:
- type: *439
+ type: *442
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *443
+ deployment_branch_policy: *446
additionalProperties: false
examples:
default:
@@ -64906,9 +65446,9 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *443
examples:
- default: *444
+ default: *447
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -64932,9 +65472,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
responses:
'204':
description: Default response
@@ -64959,9 +65499,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *17
- *19
responses:
@@ -64979,7 +65519,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &445
+ items: &448
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -65036,9 +65576,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
requestBody:
required: true
content:
@@ -65084,9 +65624,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *448
examples:
- example-wildcard: &446
+ example-wildcard: &449
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -65128,10 +65668,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
- - &447
+ - *279
+ - *280
+ - *444
+ - &450
name: branch_policy_id
in: path
required: true
@@ -65143,9 +65683,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *448
examples:
- default: *446
+ default: *449
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65164,10 +65704,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
- - *447
+ - *279
+ - *280
+ - *444
+ - *450
requestBody:
required: true
content:
@@ -65195,9 +65735,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *448
examples:
- default: *446
+ default: *449
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65216,10 +65756,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *276
- - *277
- - *441
- - *447
+ - *279
+ - *280
+ - *444
+ - *450
responses:
'204':
description: Response
@@ -65244,9 +65784,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *441
- - *277
- - *276
+ - *444
+ - *280
+ - *279
responses:
'200':
description: List of deployment protection rules
@@ -65262,7 +65802,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &448
+ items: &451
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -65281,7 +65821,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &449
+ app: &452
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -65380,9 +65920,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *441
- - *277
- - *276
+ - *444
+ - *280
+ - *279
requestBody:
content:
application/json:
@@ -65403,9 +65943,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *448
+ schema: *451
examples:
- default: &450
+ default: &453
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -65440,9 +65980,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *441
- - *277
- - *276
+ - *444
+ - *280
+ - *279
- *19
- *17
responses:
@@ -65461,7 +66001,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *449
+ items: *452
examples:
default:
value:
@@ -65496,10 +66036,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *276
- - *277
- - *441
- - &451
+ - *279
+ - *280
+ - *444
+ - &454
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -65511,9 +66051,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *451
examples:
- default: *450
+ default: *453
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65534,10 +66074,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *441
- - *277
- - *276
- - *451
+ - *444
+ - *280
+ - *279
+ - *454
responses:
'204':
description: Response
@@ -65563,9 +66103,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *17
- *19
responses:
@@ -65583,9 +66123,9 @@ paths:
type: integer
secrets:
type: array
- items: *322
+ items: *325
examples:
- default: *323
+ default: *326
headers:
Link: *58
x-github:
@@ -65610,17 +66150,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
responses:
'200':
description: Response
content:
application/json:
- schema: *324
+ schema: *327
examples:
- default: *325
+ default: *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65642,18 +66182,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *127
responses:
'200':
description: Response
content:
application/json:
- schema: *322
+ schema: *325
examples:
- default: *452
+ default: *455
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65675,9 +66215,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *127
requestBody:
required: true
@@ -65735,9 +66275,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *127
responses:
'204':
@@ -65763,10 +66303,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *276
- - *277
- - *441
- - *298
+ - *279
+ - *280
+ - *444
+ - *301
- *19
responses:
'200':
@@ -65783,9 +66323,9 @@ paths:
type: integer
variables:
type: array
- items: *326
+ items: *329
examples:
- default: *327
+ default: *330
headers:
Link: *58
x-github:
@@ -65808,9 +66348,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
requestBody:
required: true
content:
@@ -65862,18 +66402,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *276
- - *277
- - *441
+ - *279
+ - *280
+ - *444
- *130
responses:
'200':
description: Response
content:
application/json:
- schema: *326
+ schema: *329
examples:
- default: *453
+ default: *456
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65894,10 +66434,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
- - *441
+ - *444
requestBody:
required: true
content:
@@ -65939,10 +66479,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *130
- - *441
+ - *444
responses:
'204':
description: Response
@@ -65964,8 +66504,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -66042,8 +66582,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -66202,8 +66742,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -66235,9 +66775,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
'400': *14
'422': *15
'403': *29
@@ -66258,8 +66798,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -66319,7 +66859,7 @@ paths:
schema:
oneOf:
- *97
- - *454
+ - *457
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66344,8 +66884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: file_sha
in: path
required: true
@@ -66444,8 +66984,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -66554,7 +67094,7 @@ paths:
description: Response
content:
application/json:
- schema: &455
+ schema: &458
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -66768,15 +67308,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *276
- - *277
- - *408
+ - *279
+ - *280
+ - *411
responses:
'200':
description: Response
content:
application/json:
- schema: *455
+ schema: *458
examples:
default:
value:
@@ -66832,9 +67372,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *276
- - *277
- - &456
+ - *279
+ - *280
+ - &459
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.
@@ -66851,7 +67391,7 @@ paths:
application/json:
schema:
type: array
- items: &457
+ items: &460
title: Git Reference
description: Git references within a repository
type: object
@@ -66926,17 +67466,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *276
- - *277
- - *456
+ - *279
+ - *280
+ - *459
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *460
examples:
- default: &458
+ default: &461
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -66965,8 +67505,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -66995,9 +67535,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *460
examples:
- default: *458
+ default: *461
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -67023,9 +67563,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *276
- - *277
- - *456
+ - *279
+ - *280
+ - *459
requestBody:
required: true
content:
@@ -67054,9 +67594,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *460
examples:
- default: *458
+ default: *461
'422': *15
'409': *46
x-github:
@@ -67074,9 +67614,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *276
- - *277
- - *456
+ - *279
+ - *280
+ - *459
responses:
'204':
description: Response
@@ -67129,8 +67669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -67197,7 +67737,7 @@ paths:
description: Response
content:
application/json:
- schema: &460
+ schema: &463
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -67248,7 +67788,7 @@ paths:
- sha
- type
- url
- verification: *459
+ verification: *462
required:
- sha
- url
@@ -67258,7 +67798,7 @@ paths:
- tag
- message
examples:
- default: &461
+ default: &464
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -67331,8 +67871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tag_sha
in: path
required: true
@@ -67343,9 +67883,9 @@ paths:
description: Response
content:
application/json:
- schema: *460
+ schema: *463
examples:
- default: *461
+ default: *464
'404': *6
'409': *46
x-github:
@@ -67369,8 +67909,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -67443,7 +67983,7 @@ paths:
description: Response
content:
application/json:
- schema: &462
+ schema: &465
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -67460,6 +68000,11 @@ paths:
type: array
items:
type: object
+ required:
+ - path
+ - mode
+ - type
+ - sha
properties:
path:
type: string
@@ -67486,29 +68031,8 @@ paths:
size: 30
sha: 44b4fc6d56897b048c772eb4087f854f46256132
url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132
- properties:
- path:
- type: string
- mode:
- type: string
- type:
- type: string
- size:
- type: integer
- sha:
- type: string
- url:
- type: string
- required:
- - path
- - mode
- - type
- - sha
- - url
- - size
required:
- sha
- - url
- tree
- truncated
examples:
@@ -67555,8 +68079,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -67579,7 +68103,7 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *465
examples:
default-response:
summary: Default response
@@ -67638,8 +68162,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -67649,7 +68173,7 @@ paths:
application/json:
schema:
type: array
- items: &463
+ items: &466
title: Webhook
description: Webhooks for repositories.
type: object
@@ -67703,7 +68227,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &687
+ last_response: &690
title: Hook Response
type: object
properties:
@@ -67777,8 +68301,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -67830,9 +68354,9 @@ paths:
description: Response
content:
application/json:
- schema: *463
+ schema: *466
examples:
- default: &464
+ default: &467
value:
type: Repository
id: 12345678
@@ -67880,17 +68404,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'200':
description: Response
content:
application/json:
- schema: *463
+ schema: *466
examples:
- default: *464
+ default: *467
'404': *6
x-github:
githubCloudOnly: false
@@ -67910,9 +68434,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
requestBody:
required: true
content:
@@ -67957,9 +68481,9 @@ paths:
description: Response
content:
application/json:
- schema: *463
+ schema: *466
examples:
- default: *464
+ default: *467
'422': *15
'404': *6
x-github:
@@ -67980,9 +68504,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'204':
description: Response
@@ -68006,9 +68530,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'200':
description: Response
@@ -68035,9 +68559,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
requestBody:
required: false
content:
@@ -68081,11 +68605,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
- *17
- - *166
+ - *170
responses:
'200':
description: Response
@@ -68093,9 +68617,9 @@ paths:
application/json:
schema:
type: array
- items: *167
+ items: *171
examples:
- default: *168
+ default: *172
'400': *14
'422': *15
x-github:
@@ -68114,18 +68638,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *169
+ schema: *173
examples:
- default: *170
+ default: *174
'400': *14
'422': *15
x-github:
@@ -68144,9 +68668,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
- *16
responses:
'202': *47
@@ -68169,9 +68693,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'204':
description: Response
@@ -68196,9 +68720,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *276
- - *277
- - *165
+ - *279
+ - *280
+ - *169
responses:
'204':
description: Response
@@ -68256,14 +68780,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: &465
+ schema: &468
title: Import
description: A repository import from an external source.
type: object
@@ -68362,7 +68886,7 @@ paths:
- html_url
- authors_url
examples:
- default: &468
+ default: &471
value:
vcs: subversion
use_lfs: true
@@ -68378,7 +68902,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': &466
+ '503': &469
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -68407,8 +68931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -68456,7 +68980,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *468
examples:
default:
value:
@@ -68481,7 +69005,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68509,8 +69033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -68559,7 +69083,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *468
examples:
example-1:
summary: Example 1
@@ -68607,7 +69131,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': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68630,12 +69154,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68661,9 +69185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *276
- - *277
- - &634
+ - *279
+ - *280
+ - &637
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -68677,7 +69201,7 @@ paths:
application/json:
schema:
type: array
- items: &467
+ items: &470
title: Porter Author
description: Porter Author
type: object
@@ -68731,7 +69255,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': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68756,8 +69280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: author_id
in: path
required: true
@@ -68787,7 +69311,7 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *470
examples:
default:
value:
@@ -68800,7 +69324,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68824,8 +69348,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -68866,7 +69390,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68894,8 +69418,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -68922,11 +69446,11 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *468
examples:
- default: *468
+ default: *471
'422': *15
- '503': *466
+ '503': *469
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -68949,8 +69473,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -68958,8 +69482,8 @@ paths:
application/json:
schema: *22
examples:
- default: *469
- '301': *288
+ default: *472
+ '301': *291
'404': *6
x-github:
githubCloudOnly: false
@@ -68979,8 +69503,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -68988,12 +69512,12 @@ paths:
application/json:
schema:
anyOf:
- - *183
+ - *187
- type: object
properties: {}
additionalProperties: false
examples:
- default: &471
+ default: &474
value:
limit: collaborators_only
origin: repository
@@ -69018,13 +69542,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
application/json:
- schema: *470
+ schema: *473
examples:
default:
summary: Example request body
@@ -69036,9 +69560,9 @@ paths:
description: Response
content:
application/json:
- schema: *183
+ schema: *187
examples:
- default: *471
+ default: *474
'409':
description: Response
x-github:
@@ -69060,8 +69584,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -69084,8 +69608,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -69095,9 +69619,9 @@ paths:
application/json:
schema:
type: array
- items: *472
+ items: *475
examples:
- default: &627
+ default: &630
value:
- id: 1
repository:
@@ -69228,9 +69752,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *276
- - *277
- - *187
+ - *279
+ - *280
+ - *191
requestBody:
required: false
content:
@@ -69259,7 +69783,7 @@ paths:
description: Response
content:
application/json:
- schema: *472
+ schema: *475
examples:
default:
value:
@@ -69390,9 +69914,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *276
- - *277
- - *187
+ - *279
+ - *280
+ - *191
responses:
'204':
description: Response
@@ -69423,8 +69947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *276
- - *277
+ - *279
+ - *280
- 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
@@ -69472,7 +69996,7 @@ paths:
required: false
schema:
type: string
- - *192
+ - *195
- name: sort
description: What to sort results by.
in: query
@@ -69497,7 +70021,7 @@ paths:
type: array
items: *77
examples:
- default: &483
+ default: &486
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -69645,7 +70169,7 @@ paths:
state_reason: completed
headers:
Link: *58
- '301': *288
+ '301': *291
'422': *15
'404': *6
x-github:
@@ -69674,8 +70198,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -69759,7 +70283,7 @@ paths:
application/json:
schema: *77
examples:
- default: &478
+ default: &481
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -69915,7 +70439,7 @@ paths:
'422': *15
'503': *65
'404': *6
- '410': *285
+ '410': *288
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -69943,8 +70467,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *87
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -69965,9 +70489,9 @@ paths:
application/json:
schema:
type: array
- items: *473
+ items: *476
examples:
- default: &480
+ default: &483
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -70025,17 +70549,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'200':
description: Response
content:
application/json:
- schema: *473
+ schema: *476
examples:
- default: &474
+ default: &477
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -70089,8 +70613,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -70113,9 +70637,9 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *476
examples:
- default: *474
+ default: *477
'422': *15
x-github:
githubCloudOnly: false
@@ -70133,8 +70657,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'204':
@@ -70155,8 +70679,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -70183,9 +70707,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -70206,8 +70730,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -70240,16 +70764,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -70271,10 +70795,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- - *272
+ - *275
responses:
'204':
description: Response
@@ -70294,8 +70818,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -70305,7 +70829,7 @@ paths:
application/json:
schema:
type: array
- items: &477
+ items: &480
title: Issue Event
description: Issue Event
type: object
@@ -70348,8 +70872,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *475
- required: *476
+ properties: *478
+ required: *479
nullable: true
label:
title: Issue Event Label
@@ -70393,7 +70917,7 @@ paths:
properties: *20
required: *21
nullable: true
- requested_team: *188
+ requested_team: *152
dismissed_review:
title: Issue Event Dismissed Review
type: object
@@ -70656,8 +71180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: event_id
in: path
required: true
@@ -70668,7 +71192,7 @@ paths:
description: Response
content:
application/json:
- schema: *477
+ schema: *480
examples:
default:
value:
@@ -70861,7 +71385,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *285
+ '410': *288
'403': *29
x-github:
githubCloudOnly: false
@@ -70895,9 +71419,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *276
- - *277
- - &479
+ - *279
+ - *280
+ - &482
name: issue_number
description: The number that identifies the issue.
in: path
@@ -70911,10 +71435,10 @@ paths:
application/json:
schema: *77
examples:
- default: *478
- '301': *288
+ default: *481
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
'304': *37
x-github:
githubCloudOnly: false
@@ -70939,9 +71463,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -71046,13 +71570,13 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
'422': *15
'503': *65
'403': *29
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71070,9 +71594,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -71100,7 +71624,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71116,9 +71640,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
content:
application/json:
@@ -71145,7 +71669,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71167,9 +71691,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- name: assignee
in: path
required: true
@@ -71209,9 +71733,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *67
- *17
- *19
@@ -71222,13 +71746,13 @@ paths:
application/json:
schema:
type: array
- items: *473
+ items: *476
examples:
- default: *480
+ default: *483
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71257,9 +71781,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -71281,16 +71805,16 @@ paths:
description: Response
content:
application/json:
- schema: *473
+ schema: *476
examples:
- default: *474
+ default: *477
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *285
+ '410': *288
'422': *15
'404': *6
x-github:
@@ -71310,9 +71834,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -71326,7 +71850,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &484
+ - &487
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -71380,7 +71904,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &485
+ - &488
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -71516,7 +72040,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &486
+ - &489
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -71567,7 +72091,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &487
+ - &490
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -71618,7 +72142,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &488
+ - &491
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -71672,7 +72196,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &489
+ - &492
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -71706,7 +72230,7 @@ paths:
properties: *61
required: *62
review_requester: *4
- requested_team: *188
+ requested_team: *152
requested_reviewer: *4
required:
- review_requester
@@ -71719,7 +72243,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &490
+ - &493
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -71753,7 +72277,7 @@ paths:
properties: *61
required: *62
review_requester: *4
- requested_team: *188
+ requested_team: *152
requested_reviewer: *4
required:
- review_requester
@@ -71766,7 +72290,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &491
+ - &494
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -71826,7 +72350,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &492
+ - &495
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -71874,7 +72398,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &493
+ - &496
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -71940,7 +72464,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &494
+ - &497
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -72006,7 +72530,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &495
+ - &498
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -72072,7 +72596,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &496
+ - &499
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -72163,7 +72687,7 @@ paths:
color: red
headers:
Link: *58
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72180,9 +72704,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -72192,7 +72716,7 @@ paths:
application/json:
schema:
type: array
- items: &481
+ items: &484
title: Label
description: Color-coded labels help you categorize and filter your
issues (just like labels in Gmail).
@@ -72239,7 +72763,7 @@ paths:
- color
- default
examples:
- default: &482
+ default: &485
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -72257,9 +72781,9 @@ paths:
default: false
headers:
Link: *58
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72276,9 +72800,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -72337,12 +72861,12 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
- '301': *288
+ default: *485
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
'422': *15
x-github:
githubCloudOnly: false
@@ -72359,9 +72883,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -72421,12 +72945,12 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
- '301': *288
+ default: *485
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
'422': *15
x-github:
githubCloudOnly: false
@@ -72443,15 +72967,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
responses:
'204':
description: Response
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72470,9 +72994,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- name: name
in: path
required: true
@@ -72485,7 +73009,7 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
default:
value:
@@ -72496,9 +73020,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *288
+ '301': *291
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72518,9 +73042,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: false
content:
@@ -72548,7 +73072,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *285
+ '410': *288
'404': *6
'422': *15
x-github:
@@ -72566,9 +73090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
responses:
'204':
description: Response
@@ -72590,9 +73114,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -72618,13 +73142,13 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72642,9 +73166,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72676,16 +73200,16 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -72707,10 +73231,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *276
- - *277
- - *479
- - *272
+ - *279
+ - *280
+ - *482
+ - *275
responses:
'204':
description: Response
@@ -72739,9 +73263,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72765,7 +73289,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -72798,9 +73322,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -72812,11 +73336,11 @@ paths:
type: array
items: *77
examples:
- default: *483
+ default: *486
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72844,9 +73368,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72875,14 +73399,14 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *285
+ '410': *288
'422': *15
'404': *6
x-github:
@@ -72902,9 +73426,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
requestBody:
required: true
content:
@@ -72937,7 +73461,7 @@ paths:
application/json:
schema: *77
examples:
- default: *478
+ default: *481
'403': *29
'404': *6
'422': *7
@@ -72959,9 +73483,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *276
- - *277
- - *479
+ - *279
+ - *280
+ - *482
- *17
- *19
responses:
@@ -72976,9 +73500,6 @@ paths:
description: Timeline Event
type: object
anyOf:
- - *484
- - *485
- - *486
- *487
- *488
- *489
@@ -72989,6 +73510,9 @@ paths:
- *494
- *495
- *496
+ - *497
+ - *498
+ - *499
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -73293,7 +73817,7 @@ paths:
type: string
comments:
type: array
- items: &517
+ items: &520
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -73502,7 +74026,7 @@ paths:
type: string
comments:
type: array
- items: *406
+ items: *409
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -73791,7 +74315,7 @@ paths:
headers:
Link: *58
'404': *6
- '410': *285
+ '410': *288
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73808,8 +74332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -73819,7 +74343,7 @@ paths:
application/json:
schema:
type: array
- items: &497
+ items: &500
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -73884,8 +74408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -73921,9 +74445,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *500
examples:
- default: &498
+ default: &501
value:
id: 1
key: ssh-rsa AAA...
@@ -73957,9 +74481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *276
- - *277
- - &499
+ - *279
+ - *280
+ - &502
name: key_id
description: The unique identifier of the key.
in: path
@@ -73971,9 +74495,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *500
examples:
- default: *498
+ default: *501
'404': *6
x-github:
githubCloudOnly: false
@@ -73991,9 +74515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *276
- - *277
- - *499
+ - *279
+ - *280
+ - *502
responses:
'204':
description: Response
@@ -74013,8 +74537,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -74024,9 +74548,9 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
+ default: *485
headers:
Link: *58
'404': *6
@@ -74047,8 +74571,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74084,9 +74608,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *484
examples:
- default: &500
+ default: &503
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -74118,8 +74642,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: name
in: path
required: true
@@ -74130,9 +74654,9 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *484
examples:
- default: *500
+ default: *503
'404': *6
x-github:
githubCloudOnly: false
@@ -74149,8 +74673,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: name
in: path
required: true
@@ -74189,7 +74713,7 @@ paths:
description: Response
content:
application/json:
- schema: *481
+ schema: *484
examples:
default:
value:
@@ -74215,8 +74739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: name
in: path
required: true
@@ -74242,8 +74766,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -74282,9 +74806,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *276
- - *277
- - *382
+ - *279
+ - *280
+ - *385
responses:
'200':
description: Response
@@ -74429,8 +74953,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74495,8 +75019,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74530,9 +75054,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *407
+ schema: *410
examples:
- default: *501
+ default: *504
'204':
description: Response when already merged
'404':
@@ -74557,8 +75081,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -74599,12 +75123,12 @@ paths:
application/json:
schema:
type: array
- items: &502
+ items: &505
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
examples:
default:
value:
@@ -74660,8 +75184,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -74701,9 +75225,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *505
examples:
- default: &503
+ default: &506
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -74762,9 +75286,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *276
- - *277
- - &504
+ - *279
+ - *280
+ - &507
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -74776,9 +75300,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *505
examples:
- default: *503
+ default: *506
'404': *6
x-github:
githubCloudOnly: false
@@ -74795,9 +75319,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *276
- - *277
- - *504
+ - *279
+ - *280
+ - *507
requestBody:
required: false
content:
@@ -74835,9 +75359,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *505
examples:
- default: *503
+ default: *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -74853,9 +75377,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *276
- - *277
- - *504
+ - *279
+ - *280
+ - *507
responses:
'204':
description: Response
@@ -74876,9 +75400,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *276
- - *277
- - *504
+ - *279
+ - *280
+ - *507
- *17
- *19
responses:
@@ -74888,9 +75412,9 @@ paths:
application/json:
schema:
type: array
- items: *481
+ items: *484
examples:
- default: *482
+ default: *485
headers:
Link: *58
x-github:
@@ -74909,12 +75433,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *276
- - *277
- - *505
- - *506
+ - *279
+ - *280
+ - *508
+ - *509
- *67
- - *507
+ - *510
- *17
- *19
responses:
@@ -74926,7 +75450,7 @@ paths:
type: array
items: *90
examples:
- default: *508
+ default: *511
headers:
Link: *58
x-github:
@@ -74950,8 +75474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -75009,14 +75533,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: &509
+ schema: &512
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -75141,7 +75665,7 @@ paths:
- custom_404
- public
examples:
- default: &510
+ default: &513
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -75182,8 +75706,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -75237,9 +75761,9 @@ paths:
description: Response
content:
application/json:
- schema: *509
+ schema: *512
examples:
- default: *510
+ default: *513
'422': *15
'409': *46
x-github:
@@ -75262,8 +75786,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -75362,8 +75886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -75389,8 +75913,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -75400,7 +75924,7 @@ paths:
application/json:
schema:
type: array
- items: &511
+ items: &514
title: Page Build
description: Page Build
type: object
@@ -75494,8 +76018,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'201':
description: Response
@@ -75540,16 +76064,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *514
examples:
- default: &512
+ default: &515
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -75597,8 +76121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: build_id
in: path
required: true
@@ -75609,9 +76133,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *514
examples:
- default: *512
+ default: *515
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75631,8 +76155,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -75737,9 +76261,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *276
- - *277
- - &513
+ - *279
+ - *280
+ - &516
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -75797,11 +76321,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *276
- - *277
- - *513
+ - *279
+ - *280
+ - *516
responses:
- '204': *142
+ '204': *145
'404': *6
x-github:
githubCloudOnly: false
@@ -75826,8 +76350,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -76085,8 +76609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Private vulnerability reporting status
@@ -76123,10 +76647,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
- '204': *142
+ '204': *145
'422': *14
x-github:
githubCloudOnly: false
@@ -76145,10 +76669,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
- '204': *142
+ '204': *145
'422': *14
x-github:
githubCloudOnly: false
@@ -76169,8 +76693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#list-repository-projects
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: state
description: Indicates the state of the projects to return.
in: query
@@ -76191,7 +76715,7 @@ paths:
application/json:
schema:
type: array
- items: *226
+ items: *229
examples:
default:
value:
@@ -76231,7 +76755,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '410': *285
+ '410': *288
'422': *7
x-github:
githubCloudOnly: false
@@ -76254,8 +76778,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/projects/projects#create-a-repository-project
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -76281,13 +76805,13 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
- default: *284
+ default: *287
'401': *25
'403': *29
'404': *6
- '410': *285
+ '410': *288
'422': *7
x-github:
githubCloudOnly: false
@@ -76310,8 +76834,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -76319,7 +76843,7 @@ paths:
application/json:
schema:
type: array
- items: *231
+ items: *234
examples:
default:
value:
@@ -76350,8 +76874,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -76363,7 +76887,7 @@ paths:
type: array
description: A list of custom property names and associated values
to apply to the repositories.
- items: *231
+ items: *234
required:
- properties
examples:
@@ -76413,8 +76937,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -76474,9 +76998,9 @@ paths:
application/json:
schema:
type: array
- items: *514
+ items: *517
examples:
- default: *515
+ default: *518
headers:
Link: *58
'304': *37
@@ -76508,8 +77032,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -76574,7 +77098,7 @@ paths:
description: Response
content:
application/json:
- schema: &519
+ schema: &522
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -76685,8 +77209,8 @@ paths:
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
nullable: true
active_lock_reason:
type: string
@@ -76731,7 +77255,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *254
+ items: *257
nullable: true
head:
type: object
@@ -76770,14 +77294,14 @@ paths:
_links:
type: object
properties:
- comments: *413
- commits: *413
- statuses: *413
- html: *413
- issue: *413
- review_comments: *413
- review_comment: *413
- self: *413
+ comments: *416
+ commits: *416
+ statuses: *416
+ html: *416
+ issue: *416
+ review_comments: *416
+ review_comment: *416
+ self: *416
required:
- comments
- commits
@@ -76788,7 +77312,7 @@ paths:
- review_comment
- self
author_association: *63
- auto_merge: *516
+ auto_merge: *519
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -76880,7 +77404,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &520
+ default: &523
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -77407,8 +77931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sort
in: query
required: false
@@ -77437,9 +77961,9 @@ paths:
application/json:
schema:
type: array
- items: *517
+ items: *520
examples:
- default: &522
+ default: &525
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -77516,17 +78040,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
- default: &518
+ default: &521
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -77601,8 +78125,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -77625,9 +78149,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
- default: *518
+ default: *521
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -77643,8 +78167,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
responses:
'204':
@@ -77666,8 +78190,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -77694,9 +78218,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -77717,8 +78241,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
requestBody:
required: true
@@ -77751,16 +78275,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -77782,10 +78306,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *76
- - *272
+ - *275
responses:
'204':
description: Response
@@ -77828,9 +78352,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *276
- - *277
- - &521
+ - *279
+ - *280
+ - &524
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -77843,9 +78367,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *519
+ schema: *522
examples:
- default: *520
+ default: *523
'304': *37
'404': *6
'406':
@@ -77853,7 +78377,7 @@ paths:
content:
application/json:
schema: *3
- '500': *145
+ '500': *148
'503': *65
x-github:
githubCloudOnly: false
@@ -77880,9 +78404,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -77924,9 +78448,9 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *522
examples:
- default: *520
+ default: *523
'422': *15
'403': *29
x-github:
@@ -77948,9 +78472,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: true
content:
@@ -78010,17 +78534,17 @@ paths:
description: Response when the codespace was successfully created
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'401': *25
'403': *29
'404': *6
@@ -78050,9 +78574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *87
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -78073,9 +78597,9 @@ paths:
application/json:
schema:
type: array
- items: *517
+ items: *520
examples:
- default: *522
+ default: *525
headers:
Link: *58
x-github:
@@ -78108,9 +78632,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: true
content:
@@ -78215,7 +78739,7 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
example-for-a-multi-line-comment:
value:
@@ -78303,9 +78827,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *76
requestBody:
required: true
@@ -78328,7 +78852,7 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *520
examples:
default:
value:
@@ -78414,9 +78938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *17
- *19
responses:
@@ -78426,9 +78950,9 @@ paths:
application/json:
schema:
type: array
- items: *407
+ items: *410
examples:
- default: *523
+ default: *526
headers:
Link: *58
x-github:
@@ -78458,9 +78982,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *17
- *19
responses:
@@ -78470,7 +78994,7 @@ paths:
application/json:
schema:
type: array
- items: *422
+ items: *425
examples:
default:
value:
@@ -78488,7 +79012,7 @@ paths:
headers:
Link: *58
'422': *15
- '500': *145
+ '500': *148
'503': *65
x-github:
githubCloudOnly: false
@@ -78508,9 +79032,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
responses:
'204':
description: Response if pull request has been merged
@@ -78533,9 +79057,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -78646,9 +79170,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
responses:
'200':
description: Response
@@ -78664,7 +79188,7 @@ paths:
items: *4
teams:
type: array
- items: *188
+ items: *152
required:
- users
- teams
@@ -78723,9 +79247,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -78762,7 +79286,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *517
examples:
default:
value:
@@ -79298,9 +79822,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: true
content:
@@ -79334,7 +79858,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *517
examples:
default:
value:
@@ -79839,9 +80363,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
- *17
- *19
responses:
@@ -79851,7 +80375,7 @@ paths:
application/json:
schema:
type: array
- items: &524
+ items: &527
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -80002,9 +80526,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -80090,9 +80614,9 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: &526
+ default: &529
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -80155,10 +80679,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - &525
+ - *279
+ - *280
+ - *524
+ - &528
name: review_id
description: The unique identifier of the review.
in: path
@@ -80170,9 +80694,9 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: &527
+ default: &530
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -80231,10 +80755,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
requestBody:
required: true
content:
@@ -80257,7 +80781,7 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
default:
value:
@@ -80319,18 +80843,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
responses:
'200':
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: *526
+ default: *529
'422': *7
'404': *6
x-github:
@@ -80357,10 +80881,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
- *17
- *19
responses:
@@ -80443,9 +80967,9 @@ paths:
_links:
type: object
properties:
- self: *413
- html: *413
- pull_request: *413
+ self: *416
+ html: *416
+ pull_request: *416
required:
- self
- html
@@ -80588,10 +81112,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
requestBody:
required: true
content:
@@ -80619,7 +81143,7 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
default:
value:
@@ -80682,10 +81206,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *276
- - *277
- - *521
- - *525
+ - *279
+ - *280
+ - *524
+ - *528
requestBody:
required: true
content:
@@ -80720,9 +81244,9 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *527
examples:
- default: *527
+ default: *530
'404': *6
'422': *7
'403': *29
@@ -80744,9 +81268,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *276
- - *277
- - *521
+ - *279
+ - *280
+ - *524
requestBody:
required: false
content:
@@ -80809,8 +81333,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -80823,9 +81347,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *531
examples:
- default: &529
+ default: &532
value:
type: file
encoding: base64
@@ -80867,8 +81391,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: dir
description: The alternate path to look for a README file
in: path
@@ -80888,9 +81412,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *531
examples:
- default: *529
+ default: *532
'404': *6
'422': *15
x-github:
@@ -80912,8 +81436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -80923,7 +81447,7 @@ paths:
application/json:
schema:
type: array
- items: &530
+ items: &533
title: Release
description: A release.
type: object
@@ -80986,7 +81510,7 @@ paths:
author: *4
assets:
type: array
- items: &531
+ items: &534
title: Release Asset
description: Data related to a release.
type: object
@@ -81167,8 +81691,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -81244,9 +81768,9 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: &534
+ default: &537
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -81349,9 +81873,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *276
- - *277
- - &532
+ - *279
+ - *280
+ - &535
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -81363,9 +81887,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *534
examples:
- default: &533
+ default: &536
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
@@ -81399,7 +81923,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *424
+ '302': *427
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81415,9 +81939,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *276
- - *277
- - *532
+ - *279
+ - *280
+ - *535
requestBody:
required: false
content:
@@ -81445,9 +81969,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *534
examples:
- default: *533
+ default: *536
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81463,9 +81987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *276
- - *277
- - *532
+ - *279
+ - *280
+ - *535
responses:
'204':
description: Response
@@ -81489,8 +82013,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -81575,16 +82099,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81601,8 +82125,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tag
description: tag parameter
in: path
@@ -81615,9 +82139,9 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
'404': *6
x-github:
githubCloudOnly: false
@@ -81639,9 +82163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *276
- - *277
- - &535
+ - *279
+ - *280
+ - &538
name: release_id
description: The unique identifier of the release.
in: path
@@ -81655,9 +82179,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
'401':
description: Unauthorized
x-github:
@@ -81675,9 +82199,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
requestBody:
required: false
content:
@@ -81741,9 +82265,9 @@ paths:
description: Response
content:
application/json:
- schema: *530
+ schema: *533
examples:
- default: *534
+ default: *537
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -81764,9 +82288,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
responses:
'204':
description: Response
@@ -81786,9 +82310,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
- *17
- *19
responses:
@@ -81798,7 +82322,7 @@ paths:
application/json:
schema:
type: array
- items: *531
+ items: *534
examples:
default:
value:
@@ -81878,9 +82402,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:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
- name: name
in: query
required: true
@@ -81906,7 +82430,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *531
+ schema: *534
examples:
response-for-successful-upload:
value:
@@ -81960,9 +82484,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -81986,9 +82510,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
'404': *6
@@ -82009,9 +82533,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *276
- - *277
- - *535
+ - *279
+ - *280
+ - *538
requestBody:
required: true
content:
@@ -82041,16 +82565,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'201':
description: Reaction created
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
'422': *15
x-github:
githubCloudOnly: false
@@ -82072,10 +82596,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *276
- - *277
- - *535
- - *272
+ - *279
+ - *280
+ - *538
+ - *275
responses:
'204':
description: Response
@@ -82099,9 +82623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *276
- - *277
- - *344
+ - *279
+ - *280
+ - *347
- *17
- *19
responses:
@@ -82117,8 +82641,8 @@ paths:
description: A repository rule with ruleset details.
oneOf:
- allOf:
- - *536
- - &538
+ - *539
+ - &541
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -82138,65 +82662,65 @@ paths:
type: integer
description: The ID of the ruleset that includes this rule.
- allOf:
- - *537
- - *538
- - allOf:
- - *539
- - *538
- - allOf:
- *540
- - *538
- - allOf:
- *541
- - *538
- allOf:
- *542
- - *538
+ - *541
- allOf:
- *543
- - *538
+ - *541
- allOf:
- *544
- - *538
+ - *541
- allOf:
- *545
- - *538
+ - *541
- allOf:
- *546
- - *538
+ - *541
- allOf:
- *547
- - *538
+ - *541
- allOf:
- *548
- - *538
+ - *541
- allOf:
- *549
- - *538
+ - *541
- allOf:
- *550
- - *538
+ - *541
- allOf:
- *551
- - *538
+ - *541
- allOf:
- *552
- - *538
+ - *541
- allOf:
- *553
- - *538
+ - *541
- allOf:
- *554
- - *538
+ - *541
- allOf:
- *555
- - *538
+ - *541
- allOf:
- *556
- - *538
+ - *541
- allOf:
- *557
- - *538
+ - *541
+ - allOf:
+ - *558
+ - *541
+ - allOf:
+ - *559
+ - *541
+ - allOf:
+ - *560
+ - *541
examples:
default:
value:
@@ -82235,8 +82759,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- name: includes_parents
@@ -82247,7 +82771,7 @@ paths:
schema:
type: boolean
default: true
- - *558
+ - *561
responses:
'200':
description: Response
@@ -82255,7 +82779,7 @@ paths:
application/json:
schema:
type: array
- items: *241
+ items: *244
examples:
default:
value:
@@ -82286,7 +82810,7 @@ paths:
created_at: '2023-08-15T08:43:03Z'
updated_at: '2023-09-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
post:
summary: Create a repository ruleset
description: Create a ruleset for a repository.
@@ -82302,8 +82826,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
description: Request body
required: true
@@ -82323,16 +82847,16 @@ paths:
- tag
- push
default: branch
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *235
+ items: *241
+ conditions: *238
rules:
type: array
description: An array of rules within the ruleset.
- items: *240
+ items: *243
required:
- name
- enforcement
@@ -82363,9 +82887,9 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: &568
+ default: &571
value:
id: 42
name: super cool ruleset
@@ -82398,7 +82922,7 @@ paths:
created_at: '2023-07-15T08:43:03Z'
updated_at: '2023-08-23T16:29:47Z'
'404': *6
- '500': *145
+ '500': *148
"/repos/{owner}/{repo}/rulesets/rule-suites":
get:
summary: List repository rule suites
@@ -82412,12 +82936,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *276
- - *277
- - *559
- - *560
- - *561
+ - *279
+ - *280
- *562
+ - *563
+ - *564
+ - *565
- *17
- *19
responses:
@@ -82425,11 +82949,11 @@ paths:
description: Response
content:
application/json:
- schema: *563
+ schema: *566
examples:
- default: *564
+ default: *567
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82448,19 +82972,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *276
- - *277
- - *565
+ - *279
+ - *280
+ - *568
responses:
'200':
description: Response
content:
application/json:
- schema: *566
+ schema: *569
examples:
- default: *567
+ default: *570
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82486,8 +83010,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82507,11 +83031,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *568
+ default: *571
'404': *6
- '500': *145
+ '500': *148
put:
summary: Update a repository ruleset
description: Update a ruleset for a repository.
@@ -82527,8 +83051,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82553,16 +83077,16 @@ paths:
- branch
- tag
- push
- enforcement: *237
+ enforcement: *240
bypass_actors:
type: array
description: The actors that can bypass the rules in this ruleset
- items: *238
- conditions: *235
+ items: *241
+ conditions: *238
rules:
description: An array of rules within the ruleset.
type: array
- items: *240
+ items: *243
examples:
default:
value:
@@ -82590,11 +83114,11 @@ paths:
description: Response
content:
application/json:
- schema: *241
+ schema: *244
examples:
- default: *568
+ default: *571
'404': *6
- '500': *145
+ '500': *148
delete:
summary: Delete a repository ruleset
description: Delete a ruleset for a repository.
@@ -82610,8 +83134,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82622,7 +83146,7 @@ paths:
'204':
description: Response
'404': *6
- '500': *145
+ '500': *148
"/repos/{owner}/{repo}/rulesets/{ruleset_id}/history":
get:
summary: Get repository ruleset history
@@ -82634,8 +83158,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
- name: ruleset_id
@@ -82651,11 +83175,11 @@ paths:
application/json:
schema:
type: array
- items: *243
+ items: *246
examples:
- default: *569
+ default: *572
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82672,8 +83196,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -82691,7 +83215,7 @@ paths:
description: Response
content:
application/json:
- schema: *570
+ schema: *573
examples:
default:
value:
@@ -82724,7 +83248,7 @@ paths:
operator: contains
pattern: github
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82746,20 +83270,20 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *276
- - *277
- - *244
- - *245
- - *246
+ - *279
+ - *280
- *247
- - *48
- - *19
- - *17
- - *571
- - *572
- *248
- *249
- *250
+ - *48
+ - *19
+ - *17
+ - *574
+ - *575
+ - *251
+ - *252
+ - *253
responses:
'200':
description: Response
@@ -82767,7 +83291,7 @@ paths:
application/json:
schema:
type: array
- items: &575
+ items: &578
type: object
properties:
number: *54
@@ -82786,8 +83310,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *573
- resolution: *574
+ state: *576
+ resolution: *577
resolved_at:
type: string
format: date-time
@@ -83005,15 +83529,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
responses:
'200':
description: Response
content:
application/json:
- schema: *575
+ schema: *578
examples:
default:
value:
@@ -83065,9 +83589,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
requestBody:
required: true
content:
@@ -83075,8 +83599,8 @@ paths:
schema:
type: object
properties:
- state: *573
- resolution: *574
+ state: *576
+ resolution: *577
resolution_comment:
description: An optional comment when closing an alert. Cannot be
updated or deleted. Must be `null` when changing `state` to `open`.
@@ -83094,7 +83618,7 @@ paths:
description: Response
content:
application/json:
- schema: *575
+ schema: *578
examples:
default:
value:
@@ -83169,9 +83693,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *276
- - *277
- - *376
+ - *279
+ - *280
+ - *379
- *19
- *17
responses:
@@ -83182,7 +83706,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &708
+ items: &711
type: object
properties:
type:
@@ -83541,8 +84065,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -83550,14 +84074,14 @@ paths:
schema:
type: object
properties:
- reason: &577
+ reason: &580
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *576
+ placeholder_id: *579
required:
- reason
- placeholder_id
@@ -83574,7 +84098,7 @@ paths:
schema:
type: object
properties:
- reason: *577
+ reason: *580
expire_at:
type: string
format: date-time
@@ -83617,8 +84141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -83633,7 +84157,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &578
+ items: &581
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -83659,15 +84183,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *578
+ items: *581
backfill_scans:
type: array
- items: *578
+ items: *581
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *578
+ - *581
- type: object
properties:
pattern_name:
@@ -83737,8 +84261,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *48
- name: sort
description: The property to sort the results by.
@@ -83782,9 +84306,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *582
examples:
- default: *580
+ default: *583
'400': *14
'404': *6
x-github:
@@ -83807,8 +84331,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -83881,7 +84405,7 @@ paths:
login:
type: string
description: The username of the user credited.
- type: *253
+ type: *256
required:
- login
- type
@@ -83968,9 +84492,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
- default: &582
+ default: &585
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -84203,8 +84727,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -84308,7 +84832,7 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
default:
value:
@@ -84455,17 +84979,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
responses:
'200':
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
- default: *582
+ default: *585
'403': *29
'404': *6
x-github:
@@ -84489,9 +85013,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
requestBody:
required: true
content:
@@ -84564,7 +85088,7 @@ paths:
login:
type: string
description: The username of the user credited.
- type: *253
+ type: *256
required:
- login
- type
@@ -84650,10 +85174,10 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *582
examples:
- default: *582
- add_credit: *582
+ default: *585
+ add_credit: *585
'403': *29
'404': *6
'422':
@@ -84691,9 +85215,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
responses:
'202': *47
'400': *14
@@ -84720,17 +85244,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *276
- - *277
- - *581
+ - *279
+ - *280
+ - *584
responses:
'202':
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
'400': *14
'422': *15
'403': *29
@@ -84756,8 +85280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -84856,8 +85380,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -84866,7 +85390,7 @@ paths:
application/json:
schema:
type: array
- items: &583
+ items: &586
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -84879,7 +85403,7 @@ paths:
- 1124
- -435
'202': *47
- '204': *142
+ '204': *145
'422':
description: Repository contains more than 10,000 commits
x-github:
@@ -84899,8 +85423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -84949,7 +85473,7 @@ paths:
total: 89
week: 1336280400
'202': *47
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84976,8 +85500,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -85051,7 +85575,7 @@ paths:
d: 77
c: 10
'202': *47
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85073,8 +85597,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -85228,8 +85752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -85239,7 +85763,7 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *586
examples:
default:
value:
@@ -85252,7 +85776,7 @@ paths:
- - 0
- 2
- 21
- '204': *142
+ '204': *145
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85272,8 +85796,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: sha
in: path
required: true
@@ -85327,7 +85851,7 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *587
examples:
default:
value:
@@ -85381,8 +85905,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -85394,7 +85918,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -85414,14 +85938,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &585
+ schema: &588
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -85489,8 +86013,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -85516,7 +86040,7 @@ paths:
description: Response
content:
application/json:
- schema: *585
+ schema: *588
examples:
default:
value:
@@ -85543,8 +86067,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -85564,8 +86088,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -85644,8 +86168,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -85653,7 +86177,7 @@ paths:
application/json:
schema:
type: array
- items: &586
+ items: &589
title: Tag protection
description: Tag protection
type: object
@@ -85705,8 +86229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -85729,7 +86253,7 @@ paths:
description: Response
content:
application/json:
- schema: *586
+ schema: *589
examples:
default:
value:
@@ -85760,8 +86284,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -85798,8 +86322,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
in: path
required: true
@@ -85835,8 +86359,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *17
- *19
responses:
@@ -85846,9 +86370,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- default: *209
+ default: *212
headers:
Link: *58
'404': *6
@@ -85868,8 +86392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *276
- - *277
+ - *279
+ - *280
- *19
- *17
responses:
@@ -85877,7 +86401,7 @@ paths:
description: Response
content:
application/json:
- schema: &587
+ schema: &590
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -85889,7 +86413,7 @@ paths:
required:
- names
examples:
- default: &588
+ default: &591
value:
names:
- octocat
@@ -85912,8 +86436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -85944,9 +86468,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *590
examples:
- default: *588
+ default: *591
'404': *6
'422': *7
x-github:
@@ -85967,9 +86491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *276
- - *277
- - &589
+ - *279
+ - *280
+ - &592
name: per
description: The time frame to display results for.
in: query
@@ -85998,7 +86522,7 @@ paths:
example: 128
clones:
type: array
- items: &590
+ items: &593
title: Traffic
type: object
properties:
@@ -86085,8 +86609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -86176,8 +86700,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'200':
description: Response
@@ -86237,9 +86761,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *276
- - *277
- - *589
+ - *279
+ - *280
+ - *592
responses:
'200':
description: Response
@@ -86258,7 +86782,7 @@ paths:
example: 3782
views:
type: array
- items: *590
+ items: *593
required:
- uniques
- count
@@ -86335,8 +86859,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
requestBody:
required: true
content:
@@ -86610,8 +87134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -86634,8 +87158,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -86657,8 +87181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -86684,8 +87208,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *276
- - *277
+ - *279
+ - *280
- name: ref
in: path
required: true
@@ -86777,9 +87301,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -87027,7 +87551,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &591
+ text_matches: &594
title: Search Result Text Matches
type: array
items:
@@ -87189,7 +87713,7 @@ paths:
enum:
- author-date
- committer-date
- - &592
+ - &595
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
@@ -87260,7 +87784,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *342
+ properties: *345
nullable: true
comment_count:
type: integer
@@ -87280,7 +87804,7 @@ paths:
url:
type: string
format: uri
- verification: *459
+ verification: *462
required:
- author
- committer
@@ -87299,7 +87823,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *342
+ properties: *345
nullable: true
parents:
type: array
@@ -87317,7 +87841,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *591
+ text_matches: *594
required:
- sha
- node_id
@@ -87499,7 +88023,7 @@ paths:
- interactions
- created
- updated
- - *592
+ - *595
- *17
- *19
- name: advanced_search
@@ -87626,8 +88150,8 @@ paths:
title: Milestone
description: A collection of related issues and pull requests.
type: object
- properties: *411
- required: *412
+ properties: *414
+ required: *415
nullable: true
comments:
type: integer
@@ -87641,7 +88165,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *591
+ text_matches: *594
pull_request:
type: object
properties:
@@ -87685,7 +88209,7 @@ paths:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
performed_via_github_app:
title: GitHub app
description: GitHub apps are a new way to extend GitHub.
@@ -87869,7 +88393,7 @@ paths:
enum:
- created
- updated
- - *592
+ - *595
- *17
- *19
responses:
@@ -87913,7 +88437,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *591
+ text_matches: *594
required:
- id
- node_id
@@ -87998,7 +88522,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *592
+ - *595
- *17
- *19
responses:
@@ -88237,7 +88761,7 @@ paths:
- admin
- pull
- push
- text_matches: *591
+ text_matches: *594
temp_clone_token:
type: string
allow_merge_commit:
@@ -88537,7 +89061,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *591
+ text_matches: *594
related:
type: array
nullable: true
@@ -88728,7 +89252,7 @@ paths:
- followers
- repositories
- joined
- - *592
+ - *595
- *17
- *19
responses:
@@ -88832,7 +89356,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *591
+ text_matches: *594
blog:
type: string
nullable: true
@@ -88911,7 +89435,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &593
+ - &596
name: team_id
description: The unique identifier of the team.
in: path
@@ -88923,9 +89447,9 @@ paths:
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
x-github:
githubCloudOnly: false
@@ -88952,7 +89476,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *593
+ - *596
requestBody:
required: true
content:
@@ -89015,16 +89539,16 @@ paths:
description: Response when the updated information already exists
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'201':
description: Response
content:
application/json:
- schema: *261
+ schema: *264
examples:
- default: *262
+ default: *265
'404': *6
'422': *15
'403': *29
@@ -89052,7 +89576,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *593
+ - *596
responses:
'204':
description: Response
@@ -89083,7 +89607,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
parameters:
- - *593
+ - *596
- *48
- *17
- *19
@@ -89094,9 +89618,9 @@ paths:
application/json:
schema:
type: array
- items: *263
+ items: *266
examples:
- default: *594
+ default: *597
headers:
Link: *58
x-github:
@@ -89125,7 +89649,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *593
+ - *596
requestBody:
required: true
content:
@@ -89159,9 +89683,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *264
+ default: *267
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -89188,16 +89712,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
responses:
'200':
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *264
+ default: *267
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89222,8 +89746,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
requestBody:
required: false
content:
@@ -89246,9 +89770,9 @@ paths:
description: Response
content:
application/json:
- schema: *263
+ schema: *266
examples:
- default: *595
+ default: *598
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89273,8 +89797,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
responses:
'204':
description: Response
@@ -89303,8 +89827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
- *48
- *17
- *19
@@ -89315,9 +89839,9 @@ paths:
application/json:
schema:
type: array
- items: *266
+ items: *269
examples:
- default: *596
+ default: *599
headers:
Link: *58
x-github:
@@ -89346,8 +89870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
requestBody:
required: true
content:
@@ -89369,9 +89893,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *267
+ default: *270
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -89398,17 +89922,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
responses:
'200':
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *267
+ default: *270
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89433,9 +89957,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
requestBody:
required: true
content:
@@ -89457,9 +89981,9 @@ paths:
description: Response
content:
application/json:
- schema: *266
+ schema: *269
examples:
- default: *597
+ default: *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89484,9 +90008,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
responses:
'204':
description: Response
@@ -89515,9 +90039,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion comment.
@@ -89543,9 +90067,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
x-github:
@@ -89574,9 +90098,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy
parameters:
- - *593
- - *265
+ - *596
- *268
+ - *271
requestBody:
required: true
content:
@@ -89608,9 +90132,9 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89636,8 +90160,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a team discussion.
@@ -89663,9 +90187,9 @@ paths:
application/json:
schema:
type: array
- items: *269
+ items: *272
examples:
- default: *271
+ default: *274
headers:
Link: *58
x-github:
@@ -89694,8 +90218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy
parameters:
- - *593
- - *265
+ - *596
+ - *268
requestBody:
required: true
content:
@@ -89727,9 +90251,9 @@ paths:
description: Response
content:
application/json:
- schema: *269
+ schema: *272
examples:
- default: *270
+ default: *273
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -89753,7 +90277,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -89763,9 +90287,9 @@ paths:
application/json:
schema:
type: array
- items: *185
+ items: *189
examples:
- default: *186
+ default: *190
headers:
Link: *58
x-github:
@@ -89791,7 +90315,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *593
+ - *596
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -89814,7 +90338,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'404': *6
@@ -89842,7 +90366,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -89879,7 +90403,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -89919,7 +90443,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -89956,16 +90480,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: *273
+ schema: *276
examples:
- response-if-user-is-a-team-maintainer: *598
+ response-if-user-is-a-team-maintainer: *601
'404': *6
x-github:
githubCloudOnly: false
@@ -89998,7 +90522,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *593
+ - *596
- *132
requestBody:
required: false
@@ -90024,9 +90548,9 @@ paths:
description: Response
content:
application/json:
- schema: *273
+ schema: *276
examples:
- response-if-users-membership-with-team-is-now-pending: *599
+ response-if-users-membership-with-team-is-now-pending: *602
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -90060,7 +90584,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *593
+ - *596
- *132
responses:
'204':
@@ -90089,7 +90613,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -90099,9 +90623,9 @@ paths:
application/json:
schema:
type: array
- items: *274
+ items: *277
examples:
- default: *600
+ default: *603
headers:
Link: *58
'404': *6
@@ -90127,16 +90651,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy
parameters:
- - *593
- - *275
+ - *596
+ - *278
responses:
'200':
description: Response
content:
application/json:
- schema: *274
+ schema: *277
examples:
- default: *601
+ default: *604
'404':
description: Not Found if project is not managed by this team
x-github:
@@ -90160,8 +90684,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- - *593
- - *275
+ - *596
+ - *278
requestBody:
required: false
content:
@@ -90228,8 +90752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy
parameters:
- - *593
- - *275
+ - *596
+ - *278
responses:
'204':
description: Response
@@ -90256,7 +90780,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -90268,7 +90792,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
'404': *6
@@ -90298,15 +90822,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *593
- - *276
- - *277
+ - *596
+ - *279
+ - *280
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *602
+ schema: *605
examples:
alternative-response-with-extra-repository-information:
value:
@@ -90457,9 +90981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *593
- - *276
- - *277
+ - *596
+ - *279
+ - *280
requestBody:
required: false
content:
@@ -90509,9 +91033,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *593
- - *276
- - *277
+ - *596
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -90536,7 +91060,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *593
+ - *596
- *17
- *19
responses:
@@ -90546,9 +91070,9 @@ paths:
application/json:
schema:
type: array
- items: *188
+ items: *152
examples:
- response-if-child-teams-exist: *603
+ response-if-child-teams-exist: *606
headers:
Link: *58
'404': *6
@@ -90581,7 +91105,7 @@ paths:
application/json:
schema:
oneOf:
- - &605
+ - &608
title: Private User
description: Private User
type: object
@@ -90784,7 +91308,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *604
+ - *607
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -90937,7 +91461,7 @@ paths:
description: Response
content:
application/json:
- schema: *605
+ schema: *608
examples:
default:
value:
@@ -91016,7 +91540,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
'304': *37
'404': *6
'403': *29
@@ -91140,11 +91664,11 @@ paths:
type: integer
codespaces:
type: array
- items: *195
+ items: *198
examples:
- default: *196
+ default: *199
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91281,17 +91805,17 @@ paths:
description: Response when the codespace was successfully created
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'401': *25
'403': *29
'404': *6
@@ -91335,7 +91859,7 @@ paths:
type: integer
secrets:
type: array
- items: &606
+ items: &609
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -91375,7 +91899,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *399
+ default: *402
headers:
Link: *58
x-github:
@@ -91451,7 +91975,7 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *609
examples:
default:
value:
@@ -91597,11 +92121,11 @@ paths:
type: array
items: *119
examples:
- default: *607
+ default: *610
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91654,7 +92178,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91688,7 +92212,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91721,7 +92245,7 @@ paths:
'401': *25
'403': *29
'404': *6
- '500': *145
+ '500': *148
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91741,17 +92265,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91775,7 +92299,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
requestBody:
required: false
content:
@@ -91805,9 +92329,9 @@ paths:
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'401': *25
'403': *29
'404': *6
@@ -91829,11 +92353,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'202': *47
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91858,13 +92382,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'202':
description: Response
content:
application/json:
- schema: &608
+ schema: &611
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -91905,7 +92429,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &609
+ default: &612
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -91913,7 +92437,7 @@ paths:
sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2
id: latest
export_url: https://api.github.com/user/codespaces/:name/exports/latest
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -91937,7 +92461,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export
parameters:
- - *197
+ - *200
- name: export_id
in: path
required: true
@@ -91950,9 +92474,9 @@ paths:
description: Response
content:
application/json:
- schema: *608
+ schema: *611
examples:
- default: *609
+ default: *612
'404': *6
x-github:
githubCloudOnly: false
@@ -91973,7 +92497,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
@@ -91989,11 +92513,11 @@ paths:
type: integer
machines:
type: array
- items: *610
+ items: *613
examples:
- default: *611
+ default: *614
'304': *37
- '500': *145
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -92020,7 +92544,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace
parameters:
- - *197
+ - *200
requestBody:
required: true
content:
@@ -92070,13 +92594,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *287
+ repository: *290
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *397
- required: *398
+ properties: *400
+ required: *401
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -92850,17 +93374,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
+ default: *399
'304': *37
- '500': *145
+ '500': *148
'400': *14
'401': *25
'402':
@@ -92890,16 +93414,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user
parameters:
- - *197
+ - *200
responses:
'200':
description: Response
content:
application/json:
- schema: *195
+ schema: *198
examples:
- default: *396
- '500': *145
+ default: *399
+ '500': *148
'401': *25
'403': *29
'404': *6
@@ -92928,9 +93452,9 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: &624
+ default: &627
value:
- id: 197
name: hello_docker
@@ -93031,7 +93555,7 @@ paths:
application/json:
schema:
type: array
- items: &612
+ items: &615
title: Email
description: Email
type: object
@@ -93096,9 +93620,9 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *615
examples:
- default: &626
+ default: &629
value:
- email: octocat@github.com
verified: true
@@ -93173,7 +93697,7 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *615
examples:
default:
value:
@@ -93283,7 +93807,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'304': *37
@@ -93316,7 +93840,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
'304': *37
@@ -93429,7 +93953,7 @@ paths:
application/json:
schema:
type: array
- items: &613
+ items: &616
title: GPG Key
description: A unique encryption key
type: object
@@ -93560,7 +94084,7 @@ paths:
- subkeys
- revoked
examples:
- default: &637
+ default: &640
value:
- id: 3
name: Octocat's GPG Key
@@ -93645,9 +94169,9 @@ paths:
description: Response
content:
application/json:
- schema: *613
+ schema: *616
examples:
- default: &614
+ default: &617
value:
id: 3
name: Octocat's GPG Key
@@ -93704,7 +94228,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &615
+ - &618
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -93716,9 +94240,9 @@ paths:
description: Response
content:
application/json:
- schema: *613
+ schema: *616
examples:
- default: *614
+ default: *617
'404': *6
'304': *37
'403': *29
@@ -93741,7 +94265,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *615
+ - *618
responses:
'204':
description: Response
@@ -93932,7 +94456,7 @@ paths:
type: array
items: *60
examples:
- default: *616
+ default: *619
headers:
Link: *58
'404': *6
@@ -94017,12 +94541,12 @@ paths:
application/json:
schema:
anyOf:
- - *183
+ - *187
- type: object
properties: {}
additionalProperties: false
examples:
- default: *184
+ default: *188
'204':
description: Response when there are no restrictions
x-github:
@@ -94046,7 +94570,7 @@ paths:
required: true
content:
application/json:
- schema: *470
+ schema: *473
examples:
default:
value:
@@ -94057,7 +94581,7 @@ paths:
description: Response
content:
application/json:
- schema: *183
+ schema: *187
examples:
default:
value:
@@ -94138,7 +94662,7 @@ paths:
- closed
- all
default: open
- - *192
+ - *195
- name: sort
description: What to sort results by.
in: query
@@ -94163,7 +94687,7 @@ paths:
type: array
items: *77
examples:
- default: *193
+ default: *196
headers:
Link: *58
'404': *6
@@ -94196,7 +94720,7 @@ paths:
application/json:
schema:
type: array
- items: &617
+ items: &620
title: Key
description: Key
type: object
@@ -94293,9 +94817,9 @@ paths:
description: Response
content:
application/json:
- schema: *617
+ schema: *620
examples:
- default: &618
+ default: &621
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -94328,15 +94852,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *499
+ - *502
responses:
'200':
description: Response
content:
application/json:
- schema: *617
+ schema: *620
examples:
- default: *618
+ default: *621
'404': *6
'304': *37
'403': *29
@@ -94359,7 +94883,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *499
+ - *502
responses:
'204':
description: Response
@@ -94392,7 +94916,7 @@ paths:
application/json:
schema:
type: array
- items: &619
+ items: &622
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -94460,7 +94984,7 @@ paths:
- account
- plan
examples:
- default: &620
+ default: &623
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -94522,9 +95046,9 @@ paths:
application/json:
schema:
type: array
- items: *619
+ items: *622
examples:
- default: *620
+ default: *623
headers:
Link: *58
'304': *37
@@ -94564,7 +95088,7 @@ paths:
application/json:
schema:
type: array
- items: *200
+ items: *203
examples:
default:
value:
@@ -94672,7 +95196,7 @@ paths:
description: Response
content:
application/json:
- schema: *200
+ schema: *203
examples:
default:
value:
@@ -94755,7 +95279,7 @@ paths:
description: Response
content:
application/json:
- schema: *200
+ schema: *203
examples:
default:
value:
@@ -94823,7 +95347,7 @@ paths:
application/json:
schema:
type: array
- items: *202
+ items: *205
examples:
default:
value:
@@ -95076,7 +95600,7 @@ paths:
description: Response
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -95256,7 +95780,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status
parameters:
- - *203
+ - *206
- name: exclude
in: query
required: false
@@ -95269,7 +95793,7 @@ paths:
description: Response
content:
application/json:
- schema: *202
+ schema: *205
examples:
default:
value:
@@ -95463,7 +95987,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive
parameters:
- - *203
+ - *206
responses:
'302':
description: Response
@@ -95489,7 +96013,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive
parameters:
- - *203
+ - *206
responses:
'204':
description: Response
@@ -95518,8 +96042,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- - *203
- - *621
+ - *206
+ - *624
responses:
'204':
description: Response
@@ -95543,7 +96067,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration
parameters:
- - *203
+ - *206
- *17
- *19
responses:
@@ -95555,7 +96079,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
'404': *6
@@ -95590,9 +96114,9 @@ paths:
application/json:
schema:
type: array
- items: *199
+ items: *202
examples:
- default: *622
+ default: *625
headers:
Link: *58
'304': *37
@@ -95634,7 +96158,7 @@ paths:
- docker
- nuget
- container
- - *623
+ - *626
- *19
- *17
responses:
@@ -95644,10 +96168,10 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *624
- '400': *625
+ default: *627
+ '400': *628
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -95667,16 +96191,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
responses:
'200':
description: Response
content:
application/json:
- schema: *210
+ schema: *213
examples:
- default: &638
+ default: &641
value:
id: 40201
name: octo-name
@@ -95789,8 +96313,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
responses:
'204':
description: Response
@@ -95820,8 +96344,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- name: token
description: package token
schema:
@@ -95853,8 +96377,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *19
- *17
- name: state
@@ -95874,7 +96398,7 @@ paths:
application/json:
schema:
type: array
- items: *214
+ items: *217
examples:
default:
value:
@@ -95923,15 +96447,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
responses:
'200':
description: Response
content:
application/json:
- schema: *214
+ schema: *217
examples:
default:
value:
@@ -95967,9 +96491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
responses:
'204':
description: Response
@@ -95999,9 +96523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
responses:
'204':
description: Response
@@ -96057,7 +96581,7 @@ paths:
description: Response
content:
application/json:
- schema: *226
+ schema: *229
examples:
default:
value:
@@ -96129,9 +96653,9 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *615
examples:
- default: *626
+ default: *629
headers:
Link: *58
'304': *37
@@ -96244,7 +96768,7 @@ paths:
type: array
items: *60
examples:
- default: &633
+ default: &636
summary: Default response
value:
- id: 1296269
@@ -96548,9 +97072,9 @@ paths:
description: Response
content:
application/json:
- schema: *287
+ schema: *290
examples:
- default: *289
+ default: *292
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -96588,9 +97112,9 @@ paths:
application/json:
schema:
type: array
- items: *472
+ items: *475
examples:
- default: *627
+ default: *630
headers:
Link: *58
'304': *37
@@ -96613,7 +97137,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation
parameters:
- - *187
+ - *191
responses:
'204':
description: Response
@@ -96636,7 +97160,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation
parameters:
- - *187
+ - *191
responses:
'204':
description: Response
@@ -96669,7 +97193,7 @@ paths:
application/json:
schema:
type: array
- items: &628
+ items: &631
title: Social account
description: Social media account
type: object
@@ -96684,7 +97208,7 @@ paths:
- provider
- url
examples:
- default: &629
+ default: &632
value:
- provider: twitter
url: https://twitter.com/github
@@ -96746,9 +97270,9 @@ paths:
application/json:
schema:
type: array
- items: *628
+ items: *631
examples:
- default: *629
+ default: *632
'422': *15
'304': *37
'404': *6
@@ -96835,7 +97359,7 @@ paths:
application/json:
schema:
type: array
- items: &630
+ items: &633
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -96855,7 +97379,7 @@ paths:
- title
- created_at
examples:
- default: &645
+ default: &648
value:
- key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -96921,9 +97445,9 @@ paths:
description: Response
content:
application/json:
- schema: *630
+ schema: *633
examples:
- default: &631
+ default: &634
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -96954,7 +97478,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:
- - &632
+ - &635
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -96966,9 +97490,9 @@ paths:
description: Response
content:
application/json:
- schema: *630
+ schema: *633
examples:
- default: *631
+ default: *634
'404': *6
'304': *37
'403': *29
@@ -96991,7 +97515,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:
- - *632
+ - *635
responses:
'204':
description: Response
@@ -97020,7 +97544,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &646
+ - &649
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
@@ -97045,11 +97569,11 @@ paths:
type: array
items: *60
examples:
- default-response: *633
+ default-response: *636
application/vnd.github.v3.star+json:
schema:
type: array
- items: &647
+ items: &650
title: Starred Repository
description: Starred Repository
type: object
@@ -97205,8 +97729,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response if this repository is starred by you
@@ -97234,8 +97758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -97259,8 +97783,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *276
- - *277
+ - *279
+ - *280
responses:
'204':
description: Response
@@ -97295,7 +97819,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
'304': *37
@@ -97332,7 +97856,7 @@ paths:
application/json:
schema:
type: array
- items: *261
+ items: *264
examples:
default:
value:
@@ -97418,10 +97942,10 @@ paths:
application/json:
schema:
oneOf:
- - *605
- - *604
+ - *608
+ - *607
examples:
- default-response: &635
+ default-response: &638
summary: Default response
value:
login: octocat
@@ -97456,7 +97980,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &636
+ response-with-git-hub-plan-information: &639
summary: Response with GitHub plan information
value:
login: octocat
@@ -97516,7 +98040,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *634
+ - *637
- *17
responses:
'200':
@@ -97527,7 +98051,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link:
example: <https://api.github.com/users?since=135>; rel="next"
@@ -97565,11 +98089,11 @@ paths:
application/json:
schema:
oneOf:
- - *605
- - *604
+ - *608
+ - *607
examples:
- default-response: *635
- response-with-git-hub-plan-information: *636
+ default-response: *638
+ response-with-git-hub-plan-information: *639
'404': *6
x-github:
githubCloudOnly: false
@@ -97645,7 +98169,7 @@ paths:
bundle_url:
type: string
examples:
- default: *338
+ default: *341
'201':
description: Response
content:
@@ -97684,9 +98208,9 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *624
+ default: *627
'403': *29
'401': *25
x-github:
@@ -97969,7 +98493,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -98000,7 +98524,7 @@ paths:
type: array
items: *4
examples:
- default: *194
+ default: *197
headers:
Link: *58
x-github:
@@ -98090,9 +98614,9 @@ paths:
application/json:
schema:
type: array
- items: *613
+ items: *616
examples:
- default: *637
+ default: *640
headers:
Link: *58
x-github:
@@ -98196,7 +98720,7 @@ paths:
application/json:
schema: *22
examples:
- default: *469
+ default: *472
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98272,9 +98796,9 @@ paths:
application/json:
schema:
type: array
- items: *199
+ items: *202
examples:
- default: *622
+ default: *625
headers:
Link: *58
x-github:
@@ -98313,7 +98837,7 @@ paths:
- docker
- nuget
- container
- - *623
+ - *626
- *132
- *19
- *17
@@ -98324,12 +98848,12 @@ paths:
application/json:
schema:
type: array
- items: *210
+ items: *213
examples:
- default: *624
+ default: *627
'403': *29
'401': *25
- '400': *625
+ '400': *628
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98349,17 +98873,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: *210
+ schema: *213
examples:
- default: *638
+ default: *641
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98380,8 +98904,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
responses:
'204':
@@ -98414,8 +98938,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
- name: token
description: package token
@@ -98448,8 +98972,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user
parameters:
- - *212
- - *213
+ - *215
+ - *216
- *132
responses:
'200':
@@ -98458,7 +98982,7 @@ paths:
application/json:
schema:
type: array
- items: *214
+ items: *217
examples:
default:
value:
@@ -98516,16 +99040,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user
parameters:
- - *212
- - *213
- *215
+ - *216
+ - *218
- *132
responses:
'200':
description: Response
content:
application/json:
- schema: *214
+ schema: *217
examples:
default:
value:
@@ -98560,10 +99084,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user
parameters:
- - *212
- - *213
- - *132
- *215
+ - *216
+ - *132
+ - *218
responses:
'204':
description: Response
@@ -98595,10 +99119,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user
parameters:
- - *212
- - *213
- - *132
- *215
+ - *216
+ - *132
+ - *218
responses:
'204':
description: Response
@@ -98645,7 +99169,7 @@ paths:
application/json:
schema:
type: array
- items: *226
+ items: *229
examples:
default:
value:
@@ -98928,7 +99452,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -98958,9 +99482,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *642
examples:
- default: *640
+ default: *643
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -98988,9 +99512,9 @@ paths:
description: Response
content:
application/json:
- schema: *641
+ schema: *644
examples:
- default: *642
+ default: *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -99018,9 +99542,9 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *646
examples:
- default: *644
+ default: *647
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -99048,9 +99572,9 @@ paths:
application/json:
schema:
type: array
- items: *628
+ items: *631
examples:
- default: *629
+ default: *632
headers:
Link: *58
x-github:
@@ -99080,9 +99604,9 @@ paths:
application/json:
schema:
type: array
- items: *630
+ items: *633
examples:
- default: *645
+ default: *648
headers:
Link: *58
x-github:
@@ -99107,7 +99631,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *132
- - *646
+ - *649
- *48
- *17
- *19
@@ -99119,11 +99643,11 @@ paths:
schema:
anyOf:
- type: array
- items: *647
+ items: *650
- type: array
items: *60
examples:
- default-response: *633
+ default-response: *636
headers:
Link: *58
x-github:
@@ -99154,7 +99678,7 @@ paths:
type: array
items: *119
examples:
- default: *216
+ default: *219
headers:
Link: *58
x-github:
@@ -99282,7 +99806,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &648
+ enterprise: &651
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -99340,7 +99864,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &649
+ installation: &652
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -99359,7 +99883,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &650
+ organization: &653
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -99419,13 +99943,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &651
+ repository: &654
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: &681
+ properties: &684
id:
description: Unique identifier of the repository
example: 42
@@ -100108,7 +100632,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &682
+ required: &685
- archive_url
- assignees_url
- blobs_url
@@ -100259,10 +100783,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -100338,11 +100862,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- rule: &652
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ rule: &655
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)
@@ -100565,11 +101089,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- rule: *652
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ rule: *655
sender: *4
required:
- action
@@ -100752,11 +101276,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- rule: *652
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ rule: *655
sender: *4
required:
- action
@@ -100840,7 +101364,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &654
+ check_run: &657
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -100903,7 +101427,7 @@ x-webhooks:
type: string
pull_requests:
type: array
- items: *355
+ items: *358
repository: *119
status:
example: completed
@@ -100941,7 +101465,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *653
+ deployment: *656
details_url:
example: https://example.com
type: string
@@ -100991,7 +101515,7 @@ x-webhooks:
- annotations_url
pull_requests:
type: array
- items: *355
+ items: *358
started_at:
example: '2018-05-04T01:14:52Z'
type: string
@@ -101026,9 +101550,9 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- check_run
@@ -101421,10 +101945,10 @@ x-webhooks:
type: string
enum:
- created
- check_run: *654
- installation: *649
- organization: *650
- repository: *651
+ check_run: *657
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- check_run
@@ -101820,10 +102344,10 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *654
- installation: *649
- organization: *650
- repository: *651
+ check_run: *657
+ installation: *652
+ organization: *653
+ repository: *654
requested_action:
description: The action requested by the user.
type: object
@@ -102228,10 +102752,10 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *654
- installation: *649
- organization: *650
- repository: *651
+ check_run: *657
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- check_run
@@ -103208,10 +103732,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -103881,10 +104405,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -104548,10 +105072,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -104714,7 +105238,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -104859,20 +105383,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &655
+ commit_oid: &658
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: *648
- installation: *649
- organization: *650
- ref: &656
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: &659
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: *651
+ repository: *654
sender: *4
required:
- action
@@ -105034,7 +105558,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -105264,12 +105788,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -105364,7 +105888,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -105532,12 +106056,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -105700,7 +106224,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -105866,12 +106390,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -105968,7 +106492,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -106136,16 +106660,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
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: *651
+ repository: *654
sender: *4
required:
- action
@@ -106239,7 +106763,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *371
+ dismissed_comment: *374
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -106379,12 +106903,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *655
- enterprise: *648
- installation: *649
- organization: *650
- ref: *656
- repository: *651
+ commit_oid: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ ref: *659
+ repository: *654
sender: *4
required:
- action
@@ -106641,10 +107165,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -106724,18 +107248,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *650
- pusher_type: &657
+ organization: *653
+ pusher_type: &660
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &658
+ ref: &661
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -106745,7 +107269,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *651
+ repository: *654
sender: *4
required:
- ref
@@ -106827,10 +107351,10 @@ x-webhooks:
type: string
enum:
- created
- definition: *227
- enterprise: *648
- installation: *649
- organization: *650
+ definition: *230
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -106915,9 +107439,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -106994,10 +107518,10 @@ x-webhooks:
type: string
enum:
- promote_to_enterprise
- definition: *227
- enterprise: *648
- installation: *649
- organization: *650
+ definition: *230
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -107074,10 +107598,10 @@ x-webhooks:
type: string
enum:
- updated
- definition: *227
- enterprise: *648
- installation: *649
- organization: *650
+ definition: *230
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -107154,19 +107678,19 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- repository: *651
- organization: *650
+ enterprise: *651
+ installation: *652
+ repository: *654
+ organization: *653
sender: *4
new_property_values:
type: array
description: The new custom property values for the repository.
- items: *231
+ items: *234
old_property_values:
type: array
description: The old custom property values for the repository.
- items: *231
+ items: *234
required:
- action
- repository
@@ -107242,18 +107766,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- pusher_type: *657
- ref: *658
+ enterprise: *651
+ installation: *652
+ organization: *653
+ pusher_type: *660
+ ref: *661
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *651
+ repository: *654
sender: *4
required:
- ref
@@ -107337,11 +107861,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107425,11 +107949,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107513,11 +108037,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107599,11 +108123,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107685,11 +108209,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107772,11 +108296,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107858,11 +108382,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *428
- installation: *649
- organization: *650
- enterprise: *648
- repository: *651
+ alert: *431
+ installation: *652
+ organization: *653
+ enterprise: *651
+ repository: *654
sender: *4
required:
- action
@@ -107939,9 +108463,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- key: &659
+ enterprise: *651
+ installation: *652
+ key: &662
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -107977,8 +108501,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -108055,11 +108579,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- key: *659
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ key: *662
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -108620,12 +109144,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: &663
+ workflow: &666
title: Workflow
type: object
nullable: true
@@ -109351,13 +109875,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *434
+ deployment: *437
pull_requests:
type: array
- items: *519
- repository: *651
- organization: *650
- installation: *649
+ items: *522
+ repository: *654
+ organization: *653
+ installation: *652
sender: *4
responses:
'200':
@@ -109428,7 +109952,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &660
+ approver: &663
type: object
properties:
avatar_url:
@@ -109471,11 +109995,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- reviewers: &661
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ reviewers: &664
type: array
items:
type: object
@@ -109554,7 +110078,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &662
+ workflow_job_run: &665
type: object
properties:
conclusion:
@@ -110285,18 +110809,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *660
+ approver: *663
comment:
type: string
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- reviewers: *661
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ reviewers: *664
sender: *4
since:
type: string
- workflow_job_run: *662
+ workflow_job_run: *665
workflow_job_runs:
type: array
items:
@@ -111000,13 +111524,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *648
+ enterprise: *651
environment:
type: string
- installation: *649
- organization: *650
- repository: *651
- requestor: &668
+ installation: *652
+ organization: *653
+ repository: *654
+ requestor: &671
title: User
type: object
nullable: true
@@ -112905,12 +113429,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Deployment Workflow Run
type: object
@@ -113590,7 +114114,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &666
+ answer: &669
type: object
properties:
author_association:
@@ -113747,7 +114271,7 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: &664
+ discussion: &667
title: Discussion
description: A Discussion in a repository.
type: object
@@ -114033,7 +114557,7 @@ x-webhooks:
- id
labels:
type: array
- items: *481
+ items: *484
required:
- repository_url
- category
@@ -114055,10 +114579,10 @@ x-webhooks:
- author_association
- active_lock_reason
- body
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114185,11 +114709,11 @@ x-webhooks:
- from
required:
- category
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114272,11 +114796,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114358,7 +114882,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &665
+ comment: &668
type: object
properties:
author_association:
@@ -114515,11 +115039,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114602,12 +115126,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *665
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ comment: *668
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114702,12 +115226,12 @@ x-webhooks:
- from
required:
- body
- comment: *665
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ comment: *668
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114791,11 +115315,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114877,11 +115401,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -114981,11 +115505,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115067,10 +115591,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *664
- enterprise: *648
- installation: *649
- label: &667
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ label: &670
title: Label
type: object
properties:
@@ -115102,8 +115626,8 @@ x-webhooks:
- color
- default
- description
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115186,11 +115710,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115272,11 +115796,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115358,11 +115882,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115447,16 +115971,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *664
- new_repository: *651
+ new_discussion: *667
+ new_repository: *654
required:
- new_discussion
- new_repository
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115539,10 +116063,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *664
- old_answer: *666
- organization: *650
- repository: *651
+ discussion: *667
+ old_answer: *669
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115624,12 +116148,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *664
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115712,11 +116236,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115798,11 +116322,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *664
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ discussion: *667
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -115875,7 +116399,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *648
+ enterprise: *651
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -116535,9 +117059,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- forkee
@@ -116683,9 +117207,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pages:
description: The pages that were updated.
type: array
@@ -116722,7 +117246,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *651
+ repository: *654
sender: *4
required:
- pages
@@ -116798,10 +117322,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: &669
+ organization: *653
+ repositories: &672
description: An array of repository objects that the installation
can access.
type: array
@@ -116827,8 +117351,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *651
- requester: *668
+ repository: *654
+ requester: *671
sender: *4
required:
- action
@@ -116903,11 +117427,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -116983,11 +117507,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -117063,10 +117587,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories_added: &670
+ organization: *653
+ repositories_added: &673
description: An array of repository objects, which were added to
the installation.
type: array
@@ -117112,15 +117636,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *651
- repository_selection: &671
+ repository: *654
+ repository_selection: &674
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *668
+ requester: *671
sender: *4
required:
- action
@@ -117199,10 +117723,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories_added: *670
+ organization: *653
+ repositories_added: *673
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -117229,9 +117753,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *651
- repository_selection: *671
- requester: *668
+ repository: *654
+ repository_selection: *674
+ requester: *671
sender: *4
required:
- action
@@ -117310,11 +117834,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -117492,10 +118016,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
target_type:
type: string
@@ -117574,11 +118098,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *648
+ enterprise: *651
installation: *22
- organization: *650
- repositories: *669
- repository: *651
+ organization: *653
+ repositories: *672
+ repository: *654
requester:
nullable: true
sender: *4
@@ -117830,8 +118354,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -118654,7 +119178,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -118987,8 +119511,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -119068,7 +119592,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &672
+ comment: &675
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -119233,8 +119757,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -120053,7 +120577,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -120388,8 +120912,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -120469,7 +120993,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &700
+ changes: &703
description: The changes to the comment.
type: object
properties:
@@ -120481,9 +121005,9 @@ x-webhooks:
type: string
required:
- from
- comment: *672
- enterprise: *648
- installation: *649
+ comment: *675
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -121305,7 +121829,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -121638,8 +122162,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -121721,10 +122245,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *668
- enterprise: *648
- installation: *649
- issue: &675
+ assignee: *671
+ enterprise: *651
+ installation: *652
+ issue: &678
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -122542,7 +123066,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -122643,8 +123167,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -122724,8 +123248,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -123548,7 +124072,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -123784,8 +124308,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -123864,8 +124388,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -124677,7 +125201,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -124777,8 +125301,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -124857,8 +125381,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -125694,7 +126218,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -125773,7 +126297,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &673
+ milestone: &676
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -125911,8 +126435,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -126011,8 +126535,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -126827,7 +127351,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
title:
description: Title of the issue
type: string
@@ -126931,9 +127455,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *667
- organization: *650
- repository: *651
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -127013,8 +127537,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -127828,7 +128352,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
title:
description: Title of the issue
type: string
@@ -127932,9 +128456,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *667
- organization: *650
- repository: *651
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -128014,8 +128538,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -128853,7 +129377,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *189
+ type: *192
title:
description: Title of the issue
type: string
@@ -128934,8 +129458,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -129014,8 +129538,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -129850,7 +130374,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -129928,9 +130452,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *673
- organization: *650
- repository: *651
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -131391,8 +131915,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -132210,7 +132734,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -132310,8 +132834,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -132391,9 +132915,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *648
- installation: *649
- issue: &674
+ enterprise: *651
+ installation: *652
+ issue: &677
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -133205,7 +133729,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -133305,8 +133829,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -133385,8 +133909,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -134303,9 +134827,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- type: *189
- organization: *650
- repository: *651
+ type: *192
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -135200,7 +135724,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -135768,11 +136292,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *648
- installation: *649
- issue: *674
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *677
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -135852,12 +136376,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *648
- installation: *649
- issue: *675
- type: *189
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ type: *192
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -135938,7 +136462,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &703
+ assignee: &706
title: User
type: object
nullable: true
@@ -136008,11 +136532,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *648
- installation: *649
- issue: *675
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -136091,12 +136615,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *648
- installation: *649
- issue: *675
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -136176,8 +136700,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -137016,7 +137540,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *189
+ type: *192
updated_at:
type: string
format: date-time
@@ -137094,8 +137618,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137175,11 +137699,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *648
- installation: *649
- issue: *674
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *677
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137258,12 +137782,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *648
- installation: *649
- issue: *675
- type: *189
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ issue: *678
+ type: *192
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137343,11 +137867,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137425,11 +137949,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137539,11 +138063,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- label: *667
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ label: *670
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -137625,9 +138149,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: &676
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: &679
title: Marketplace Purchase
type: object
required:
@@ -137710,8 +138234,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *650
- previous_marketplace_purchase: &677
+ organization: *653
+ previous_marketplace_purchase: &680
title: Marketplace Purchase
type: object
properties:
@@ -137791,7 +138315,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -137871,10 +138395,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: *676
- organization: *650
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: *679
+ organization: *653
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -137957,7 +138481,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -138039,10 +138563,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: *676
- organization: *650
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: *679
+ organization: *653
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -138124,7 +138648,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -138205,8 +138729,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -138288,9 +138812,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *650
- previous_marketplace_purchase: *677
- repository: *651
+ organization: *653
+ previous_marketplace_purchase: *680
+ repository: *654
sender: *4
required:
- action
@@ -138370,12 +138894,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *648
- installation: *649
- marketplace_purchase: *676
- organization: *650
- previous_marketplace_purchase: *677
- repository: *651
+ enterprise: *651
+ installation: *652
+ marketplace_purchase: *679
+ organization: *653
+ previous_marketplace_purchase: *680
+ repository: *654
sender: *4
required:
- action
@@ -138477,11 +139001,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -138581,11 +139105,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -138664,11 +139188,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -138746,11 +139270,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -138826,7 +139350,7 @@ x-webhooks:
required:
- login
- id
- team: &678
+ team: &681
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -139016,11 +139540,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *648
- installation: *649
- member: *668
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ member: *671
+ organization: *653
+ repository: *654
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -139097,7 +139621,7 @@ x-webhooks:
required:
- login
- id
- team: *678
+ team: *681
required:
- action
- scope
@@ -139179,8 +139703,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *649
- merge_group: &680
+ installation: *652
+ merge_group: &683
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -139199,15 +139723,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *679
+ head_commit: *682
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139293,10 +139817,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *649
- merge_group: *680
- organization: *650
- repository: *651
+ installation: *652
+ merge_group: *683
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139369,7 +139893,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
+ enterprise: *651
hook:
description: 'The modified webhook. This will contain different
keys based on the type of webhook it is: repository, organization,
@@ -139477,16 +140001,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *649
- organization: *650
+ installation: *652
+ organization: *653
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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -139567,11 +140091,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
- milestone: *673
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139650,9 +140174,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- milestone: &683
+ enterprise: *651
+ installation: *652
+ milestone: &686
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -139789,8 +140313,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139869,11 +140393,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- milestone: *673
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -139983,11 +140507,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- milestone: *673
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *676
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140067,11 +140591,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *648
- installation: *649
- milestone: *683
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ milestone: *686
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140150,11 +140674,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *668
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ blocked_user: *671
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140233,11 +140757,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *668
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ blocked_user: *671
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140316,9 +140840,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- membership: &684
+ enterprise: *651
+ installation: *652
+ membership: &687
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -140410,8 +140934,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140489,11 +141013,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *648
- installation: *649
- membership: *684
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ membership: *687
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140572,8 +141096,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -140689,10 +141213,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
- user: *668
+ user: *671
required:
- action
- invitation
@@ -140770,11 +141294,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *648
- installation: *649
- membership: *684
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ membership: *687
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140861,11 +141385,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *648
- installation: *649
- membership: *684
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ membership: *687
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -140941,9 +141465,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
package:
description: Information about the package.
type: object
@@ -141442,7 +141966,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &685
+ items: &688
title: Ruby Gems metadata
type: object
properties:
@@ -141537,7 +142061,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -141613,9 +142137,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
package:
description: Information about the package.
type: object
@@ -141968,7 +142492,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *685
+ items: *688
source_url:
type: string
format: uri
@@ -142038,7 +142562,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -142215,12 +142739,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *648
+ enterprise: *651
id:
type: integer
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- id
@@ -142297,7 +142821,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &686
+ personal_access_token_request: &689
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -142443,10 +142967,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *648
- organization: *650
+ enterprise: *651
+ organization: *653
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142523,11 +143047,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *686
- enterprise: *648
- organization: *650
+ personal_access_token_request: *689
+ enterprise: *651
+ organization: *653
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142603,11 +143127,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *686
- enterprise: *648
- organization: *650
+ personal_access_token_request: *689
+ enterprise: *651
+ organization: *653
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142682,11 +143206,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *686
- organization: *650
- enterprise: *648
+ personal_access_token_request: *689
+ organization: *653
+ enterprise: *651
sender: *4
- installation: *649
+ installation: *652
required:
- action
- personal_access_token_request
@@ -142791,7 +143315,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *687
+ last_response: *690
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -142823,8 +143347,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
zen:
description: Random string of GitHub zen.
@@ -143069,10 +143593,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *648
- installation: *649
- organization: *650
- project_card: &688
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_card: &691
title: Project Card
type: object
properties:
@@ -143191,7 +143715,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -143272,11 +143796,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- project_card: *688
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_card: *691
+ repository: *654
sender: *4
required:
- action
@@ -143356,9 +143880,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
project_card:
title: Project Card
type: object
@@ -143486,8 +144010,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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -143581,11 +144105,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *648
- installation: *649
- organization: *650
- project_card: *688
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_card: *691
+ repository: *654
sender: *4
required:
- action
@@ -143679,9 +144203,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
project_card:
allOf:
- title: Project Card
@@ -143871,7 +144395,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -143951,10 +144475,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
- organization: *650
- project: &690
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: &693
title: Project
type: object
properties:
@@ -144078,7 +144602,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -144158,10 +144682,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- project_column: &689
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: &692
title: Project Column
type: object
properties:
@@ -144200,7 +144724,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -144279,18 +144803,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- project_column: *689
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: *692
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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -144380,11 +144904,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- project_column: *689
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: *692
+ repository: *654
sender: *4
required:
- action
@@ -144464,11 +144988,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *648
- installation: *649
- organization: *650
- project_column: *689
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project_column: *692
+ repository: *654
sender: *4
required:
- action
@@ -144548,11 +145072,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
+ repository: *654
sender: *4
required:
- action
@@ -144632,18 +145156,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
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: *681
- required: *682
+ properties: *684
+ required: *685
nullable: true
sender: *4
required:
@@ -144745,11 +145269,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
+ repository: *654
sender: *4
required:
- action
@@ -144828,11 +145352,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *648
- installation: *649
- organization: *650
- project: *690
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ project: *693
+ repository: *654
sender: *4
required:
- action
@@ -144913,9 +145437,9 @@ x-webhooks:
type: string
enum:
- closed
- installation: *649
- organization: *650
- projects_v2: &691
+ installation: *652
+ organization: *653
+ projects_v2: &694
title: Projects v2 Project
description: A projects v2 project
type: object
@@ -145058,9 +145582,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -145141,9 +145665,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -145260,9 +145784,9 @@ x-webhooks:
type: string
to:
type: string
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -145345,7 +145869,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &695
+ changes: &698
type: object
properties:
archived_at:
@@ -145359,9 +145883,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *649
- organization: *650
- projects_v2_item: &692
+ installation: *652
+ organization: *653
+ projects_v2_item: &695
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -145495,9 +146019,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145579,9 +146103,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145662,9 +146186,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145770,7 +146294,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &693
+ - &696
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -145788,7 +146312,7 @@ x-webhooks:
required:
- id
- name
- - &694
+ - &697
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -145811,8 +146335,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *693
- - *694
+ - *696
+ - *697
required:
- field_value
- type: object
@@ -145828,9 +146352,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -145925,9 +146449,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *649
- organization: *650
- projects_v2_item: *692
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -146010,10 +146534,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *695
- installation: *649
- organization: *650
- projects_v2_item: *692
+ changes: *698
+ installation: *652
+ organization: *653
+ projects_v2_item: *695
sender: *4
required:
- action
@@ -146095,9 +146619,9 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *649
- organization: *650
- projects_v2: *691
+ installation: *652
+ organization: *653
+ projects_v2: *694
sender: *4
required:
- action
@@ -146178,9 +146702,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *649
- organization: *650
- projects_v2_status_update: &696
+ installation: *652
+ organization: *653
+ projects_v2_status_update: &699
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
@@ -146307,9 +146831,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *649
- organization: *650
- projects_v2_status_update: *696
+ installation: *652
+ organization: *653
+ projects_v2_status_update: *699
sender: *4
required:
- action
@@ -146445,9 +146969,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *649
- organization: *650
- projects_v2_status_update: *696
+ installation: *652
+ organization: *653
+ projects_v2_status_update: *699
sender: *4
required:
- action
@@ -146518,10 +147042,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- repository
@@ -146598,13 +147122,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *668
- enterprise: *648
- installation: *649
- number: &697
+ assignee: *671
+ enterprise: *651
+ installation: *652
+ number: &700
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -148887,7 +149411,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -148969,11 +149493,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -151251,7 +151775,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -151333,11 +151857,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -153615,7 +154139,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -153697,13 +154221,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: &698
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: &701
allOf:
- - *519
+ - *522
- type: object
properties:
allow_auto_merge:
@@ -153765,7 +154289,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -153846,12 +154370,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -153931,11 +154455,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *648
- milestone: *502
- number: *697
- organization: *650
- pull_request: &699
+ enterprise: *651
+ milestone: *505
+ number: *700
+ organization: *653
+ pull_request: &702
title: Pull Request
type: object
properties:
@@ -156198,7 +156722,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -156277,11 +156801,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -158563,7 +159087,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -158687,12 +159211,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -158772,11 +159296,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -161043,7 +161567,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -161123,11 +161647,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *648
- installation: *649
- label: *667
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ label: *670
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -163409,7 +163933,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -163490,10 +164014,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -165773,7 +166297,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -165853,12 +166377,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *648
- milestone: *502
- number: *697
- organization: *650
- pull_request: *699
- repository: *651
+ enterprise: *651
+ milestone: *505
+ number: *700
+ organization: *653
+ pull_request: *702
+ repository: *654
sender: *4
required:
- action
@@ -165937,12 +166461,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -166023,12 +166547,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -166108,12 +166632,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
- pull_request: *698
- repository: *651
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
+ pull_request: *701
+ repository: *654
sender: *4
required:
- action
@@ -166479,9 +167003,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
type: object
properties:
@@ -168651,7 +169175,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -168731,7 +169255,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &701
+ comment: &704
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -169016,9 +169540,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
type: object
properties:
@@ -171176,7 +171700,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -171256,11 +171780,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *700
- comment: *701
- enterprise: *648
- installation: *649
- organization: *650
+ changes: *703
+ comment: *704
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
type: object
properties:
@@ -173421,7 +173945,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -173502,9 +174026,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -175677,7 +176201,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
+ repository: *654
review:
description: The review that was affected.
type: object
@@ -175920,9 +176444,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -177976,8 +178500,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
- review: &702
+ repository: *654
+ review: &705
description: The review that was affected.
type: object
properties:
@@ -178206,12 +178730,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -180494,7 +181018,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_reviewer:
title: User
type: object
@@ -180578,12 +181102,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -182873,7 +183397,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -183065,12 +183589,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -185355,7 +185879,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_reviewer:
title: User
type: object
@@ -185440,12 +185964,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *648
- installation: *649
+ enterprise: *651
+ installation: *652
number:
description: The pull request number.
type: integer
- organization: *650
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -187721,7 +188245,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -187902,9 +188426,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -190079,8 +190603,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
- review: *702
+ repository: *654
+ review: *705
sender: *4
required:
- action
@@ -190160,9 +190684,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -192232,7 +192756,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
thread:
type: object
@@ -192615,9 +193139,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
pull_request:
title: Simple Pull Request
type: object
@@ -194673,7 +195197,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *651
+ repository: *654
sender: *4
thread:
type: object
@@ -195059,10 +195583,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -197333,7 +197857,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -197415,11 +197939,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *703
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ assignee: *706
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -199702,7 +200226,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -199781,11 +200305,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *648
- installation: *649
- label: *667
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ label: *670
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -202058,7 +202582,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -202139,10 +202663,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *648
- installation: *649
- number: *697
- organization: *650
+ enterprise: *651
+ installation: *652
+ number: *700
+ organization: *653
pull_request:
title: Pull Request
type: object
@@ -204407,7 +204931,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -204607,7 +205131,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *648
+ enterprise: *651
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -204699,8 +205223,8 @@ x-webhooks:
- url
- author
- committer
- installation: *649
- organization: *650
+ installation: *652
+ organization: *653
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -205275,9 +205799,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
registry_package:
type: object
properties:
@@ -205723,7 +206247,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *685
+ items: *688
summary:
type: string
tag_name:
@@ -205777,7 +206301,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -205855,9 +206379,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
registry_package:
type: object
properties:
@@ -206165,7 +206689,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *685
+ items: *688
summary:
type: string
tag_name:
@@ -206214,7 +206738,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -206291,10 +206815,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- release: &704
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: &707
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -206599,7 +207123,7 @@ x-webhooks:
- tarball_url
- zipball_url
- body
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -206676,11 +207200,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- release: *704
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *707
+ repository: *654
sender: *4
required:
- action
@@ -206797,11 +207321,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *648
- installation: *649
- organization: *650
- release: *704
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *707
+ repository: *654
sender: *4
required:
- action
@@ -206879,9 +207403,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -207190,7 +207714,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -207266,10 +207790,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
- release: &705
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: &708
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -207575,7 +208099,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *651
+ repository: *654
sender: *4
required:
- action
@@ -207651,11 +208175,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *648
- installation: *649
- organization: *650
- release: *704
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *707
+ repository: *654
sender: *4
required:
- action
@@ -207731,11 +208255,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *648
- installation: *649
- organization: *650
- release: *705
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ release: *708
+ repository: *654
sender: *4
required:
- action
@@ -207811,11 +208335,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_advisory: *579
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_advisory: *582
sender: *4
required:
- action
@@ -207891,11 +208415,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_advisory: *579
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_advisory: *582
sender: *4
required:
- action
@@ -207971,10 +208495,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208051,10 +208575,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208132,10 +208656,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208219,10 +208743,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208334,10 +208858,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208409,10 +208933,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
status:
type: string
@@ -208493,10 +209017,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208573,10 +209097,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208670,10 +209194,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -208753,11 +209277,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_ruleset: *241
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_ruleset: *244
sender: *4
required:
- action
@@ -208835,11 +209359,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_ruleset: *241
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_ruleset: *244
sender: *4
required:
- action
@@ -208917,11 +209441,11 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- repository_ruleset: *241
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ repository_ruleset: *244
changes:
type: object
properties:
@@ -208940,16 +209464,16 @@ x-webhooks:
properties:
added:
type: array
- items: *235
+ items: *238
deleted:
type: array
- items: *235
+ items: *238
updated:
type: array
items:
type: object
properties:
- condition: *235
+ condition: *238
changes:
type: object
properties:
@@ -208982,16 +209506,16 @@ x-webhooks:
properties:
added:
type: array
- items: *240
+ items: *243
deleted:
type: array
- items: *240
+ items: *243
updated:
type: array
items:
type: object
properties:
- rule: *240
+ rule: *243
changes:
type: object
properties:
@@ -209225,10 +209749,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209306,10 +209830,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209387,7 +209911,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &706
+ alert: &709
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -209508,10 +210032,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209717,10 +210241,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -209798,11 +210322,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *706
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *709
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210001,10 +210525,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210082,7 +210606,7 @@ x-webhooks:
type: string
enum:
- created
- alert: &707
+ alert: &710
type: object
properties:
number: *54
@@ -210193,10 +210717,10 @@ x-webhooks:
description: Whether the detected secret was found in multiple
repositories in the same organization or business.
nullable: true
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210277,11 +210801,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *707
- installation: *649
- location: *708
- organization: *650
- repository: *651
+ alert: *710
+ installation: *652
+ location: *711
+ organization: *653
+ repository: *654
sender: *4
required:
- location
@@ -210519,11 +211043,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210601,11 +211125,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210683,11 +211207,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210765,11 +211289,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *707
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ alert: *710
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -210895,10 +211419,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *651
- enterprise: *648
- installation: *649
- organization: *650
+ repository: *654
+ enterprise: *651
+ installation: *652
+ organization: *653
sender: *4
required:
- action
@@ -210976,11 +211500,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- security_advisory: &709
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ security_advisory: &712
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -211163,11 +211687,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
- security_advisory: *709
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
+ security_advisory: *712
sender: *4
required:
- action
@@ -211240,10 +211764,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -211427,11 +211951,11 @@ x-webhooks:
from:
type: object
properties:
- security_and_analysis: *234
- enterprise: *648
- installation: *649
- organization: *650
- repository: *287
+ security_and_analysis: *237
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *290
sender: *4
required:
- changes
@@ -211509,12 +212033,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: &710
+ sponsorship: &713
type: object
properties:
created_at:
@@ -211815,12 +212339,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- sponsorship
@@ -211908,12 +212432,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- changes
@@ -211990,17 +212514,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &711
+ effective_date: &714
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: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- sponsorship
@@ -212074,7 +212598,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &712
+ changes: &715
type: object
properties:
tier:
@@ -212118,13 +212642,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *711
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ effective_date: *714
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- changes
@@ -212201,13 +212725,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *712
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ changes: *715
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- sponsorship: *710
+ sponsorship: *713
required:
- action
- changes
@@ -212281,10 +212805,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -212367,10 +212891,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -212790,15 +213314,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *648
+ enterprise: *651
id:
description: The unique identifier of the status.
type: integer
- installation: *649
+ installation: *652
name:
type: string
- organization: *650
- repository: *651
+ organization: *653
+ repository: *654
sender: *4
sha:
description: The Commit SHA.
@@ -212913,9 +213437,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213005,9 +213529,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213097,9 +213621,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213189,9 +213713,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *77
- installation: *649
- organization: *650
- repository: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -213268,12 +213792,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- team: &713
+ team: &716
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -213463,9 +213987,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -213923,7 +214447,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -213999,9 +214523,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -214459,7 +214983,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -214536,9 +215060,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -214996,7 +215520,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -215140,9 +215664,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -215600,7 +216124,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- changes
@@ -215678,9 +216202,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *648
- installation: *649
- organization: *650
+ enterprise: *651
+ installation: *652
+ organization: *653
repository:
title: Repository
description: A git repository
@@ -216138,7 +216662,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *713
+ team: *716
required:
- action
- team
@@ -216214,10 +216738,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
required:
- action
@@ -216290,16 +216814,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *648
+ enterprise: *651
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *649
- organization: *650
+ installation: *652
+ organization: *653
ref:
type: string
- repository: *651
+ repository: *654
sender: *4
workflow:
type: string
@@ -216381,10 +216905,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
allOf:
@@ -216621,7 +217145,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -216700,10 +217224,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
allOf:
@@ -216963,7 +217487,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -217042,10 +217566,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
type: object
@@ -217180,7 +217704,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -217259,10 +217783,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
workflow_job:
type: object
@@ -217398,7 +217922,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *434
+ deployment: *437
required:
- action
- repository
@@ -217478,12 +218002,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Workflow Run
type: object
@@ -218482,12 +219006,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Workflow Run
type: object
@@ -219471,12 +219995,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *648
- installation: *649
- organization: *650
- repository: *651
+ enterprise: *651
+ installation: *652
+ organization: *653
+ repository: *654
sender: *4
- workflow: *663
+ workflow: *666
workflow_run:
title: Workflow Run
type: object