summaryrefslogtreecommitdiffstats
path: root/descriptions/api.github.com/api.github.com.json
diff options
context:
space:
mode:
Diffstat (limited to 'descriptions/api.github.com/api.github.com.json')
-rw-r--r--descriptions/api.github.com/api.github.com.json1131
1 files changed, 925 insertions, 206 deletions
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": [
{