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 e17514c87..823c9403e 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
@@ -29369,307 +29369,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
"summary": "List pending team invitations",
@@ -65632,307 +65331,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -120707,15 +120105,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -120779,8 +120168,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -120794,86 +120181,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "
Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -290618,8 +289925,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -290671,8 +289976,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -290723,8 +290026,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -290750,149 +290051,6 @@
}
}
},
- "team-discussion-comment-items": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "team-discussion-comment": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
- "team-discussion-comment-2": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
"team-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -311925,15 +311083,6 @@
"type": "integer"
}
},
- "comment-number": {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
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 85d4b802f..8b2d200c3 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
@@ -21250,217 +21250,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47660,227 +47449,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -88586,13 +88154,6 @@ components:
the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -88644,8 +88205,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -88657,72 +88216,6 @@ components:
- title
- updated_at
- url
- team-discussion-comment:
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -218279,8 +217772,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -218327,8 +217818,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -218375,8 +217864,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -218399,135 +217886,6 @@ components:
hooray: 0
eyes: 1
rocket: 1
- team-discussion-comment-items:
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment:
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment-2:
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
team-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -236717,13 +236075,6 @@ components:
required: true
schema:
type: integer
- comment-number:
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
index e17514c87..823c9403e 100644
--- a/descriptions/api.github.com/api.github.com.json
+++ b/descriptions/api.github.com/api.github.com.json
@@ -29369,307 +29369,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
"summary": "List pending team invitations",
@@ -65632,307 +65331,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -120707,15 +120105,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -120779,8 +120168,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -120794,86 +120181,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -290618,8 +289925,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -290671,8 +289976,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -290723,8 +290026,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -290750,149 +290051,6 @@
}
}
},
- "team-discussion-comment-items": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "team-discussion-comment": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
- "team-discussion-comment-2": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
"team-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -311925,15 +311083,6 @@
"type": "integer"
}
},
- "comment-number": {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
index 85d4b802f..8b2d200c3 100644
--- a/descriptions/api.github.com/api.github.com.yaml
+++ b/descriptions/api.github.com/api.github.com.yaml
@@ -21250,217 +21250,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47660,227 +47449,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -88586,13 +88154,6 @@ components:
the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -88644,8 +88205,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -88657,72 +88216,6 @@ components:
- title
- updated_at
- url
- team-discussion-comment:
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -218279,8 +217772,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -218327,8 +217818,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -218375,8 +217864,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -218399,135 +217886,6 @@ components:
hooray: 0
eyes: 1
rocket: 1
- team-discussion-comment-items:
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment:
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment-2:
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
team-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -236717,13 +236075,6 @@ components:
required: true
schema:
type: integer
- comment-number:
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
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 6bb7383dc..1b1074aa4 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
@@ -199306,15 +199306,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -199424,8 +199415,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -199467,8 +199456,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -199732,15 +199719,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -199850,8 +199828,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -199891,8 +199867,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -200122,15 +200096,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -200240,8 +200205,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -200281,8 +200244,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -200536,15 +200497,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -200654,8 +200606,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -200695,8 +200645,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -200787,17 +200735,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-in-org",
+ "operationId": "teams/list-pending-invitations-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
},
"parameters": [
{
@@ -200818,29 +200766,6 @@
"type": "string"
}
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
{
"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).\"",
@@ -200868,11 +200793,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -200994,125 +200945,34 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ ]
},
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "team_count": {
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
},
- "updated_at": {
+ "invitation_teams_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
},
- "url": {
+ "invitation_source": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "example": "\"member\""
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
+ "id",
+ "login",
+ "email",
+ "role",
"created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
]
}
},
@@ -201120,49 +200980,37 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "avatar_url": "https://github.com/images/error/other_user_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",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
}
]
}
@@ -201183,19 +201031,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -201217,298 +201067,175 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "integer"
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
+ },
+ {
+ "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": "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
}
}
- },
+ ],
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "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"
- }
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
+ "email": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
+ "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"
+ ]
+ }
},
"examples": {
"default": {
- "value": {
- "author": {
+ "value": [
+ {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -201527,57 +201254,41 @@
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
}
- }
+ ]
}
}
}
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
}
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
"get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -201599,21 +201310,12 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
@@ -201623,323 +201325,73 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
"value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
}
}
}
}
}
+ },
+ "404": {
+ "description": "if user has no team membership"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -201961,44 +201413,38 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "body": "Do you like pineapples?"
+ "role": "maintainer"
}
}
}
@@ -202011,1133 +201457,42 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/invitations": {
- "get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-pending-invitations-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "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": "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
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
- },
- "email": {
- "type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": "string",
- "nullable": true
- },
- "failed_reason": {
- "type": "string",
- "nullable": true
- },
- "inviter": {
- "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_count": {
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
- },
- "invitation_teams_url": {
- "type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
- },
- "invitation_source": {
- "type": "string",
- "example": "\"member\""
- }
- },
- "required": [
- "id",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_id"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1,
- "login": "monalisa",
- "node_id": "MDQ6VXNlcjE=",
- "email": "octocat@github.com",
- "role": "direct_member",
- "created_at": "2016-11-30T06:46:10-08:00",
- "failed_at": "",
- "failed_reason": "",
- "inviter": {
- "login": "other_user",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/other_user_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/other_user",
- "html_url": "https://github.com/other_user",
- "followers_url": "https://api.github.com/users/other_user/followers",
- "following_url": "https://api.github.com/users/other_user/following{/other_user}",
- "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
- "organizations_url": "https://api.github.com/users/other_user/orgs",
- "repos_url": "https://api.github.com/users/other_user/repos",
- "events_url": "https://api.github.com/users/other_user/events{/privacy}",
- "received_events_url": "https://api.github.com/users/other_user/received_events",
- "type": "User",
- "site_admin": false
- },
- "team_count": 2,
- "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
- "invitation_source": "member"
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "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": "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
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "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"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "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
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
"url": "https://api.github.com/teams/1/memberships/octocat",
"role": "member",
@@ -528397,2455 +526752,703 @@
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- }
- }
- }
- }
- }
- }
- },
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null,
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "is_verified": true,
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- }
- }
- }
- }
- }
- }
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "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": "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
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- },
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
}
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
+ "201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
- "example": 0
+ "example": 3
},
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
+ "login",
"url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null,
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "is_verified": true,
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
"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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -530854,20 +527457,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-legacy",
+ "operationId": "teams/delete-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -530878,20 +527481,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -530900,22 +527589,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
+ "/teams/{team_id}/discussions": {
"get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List discussions (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-legacy",
+ "operationId": "teams/list-discussions-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
},
"parameters": [
{
@@ -530927,15 +527616,6 @@
"type": "integer"
}
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
{
"name": "direction",
"description": "The direction to sort the results by.",
@@ -530977,8 +527657,8 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -531107,13 +527787,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -531123,41 +527803,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -531216,10 +527911,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -531249,19 +527947,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -531294,20 +527995,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Create a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-legacy",
+ "operationId": "teams/create-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
},
"parameters": [
{
@@ -531318,15 +528019,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -531336,19 +528028,30 @@
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
}
},
"required": [
+ "title",
"body"
]
},
"examples": {
"default": {
"value": {
- "body": "Do you like apples?"
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
}
}
}
@@ -531361,8 +528064,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -531491,13 +528194,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -531507,41 +528210,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -531600,10 +528318,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -531631,19 +528352,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -531668,22 +528392,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/teams/{team_id}/discussions/{discussion_number}": {
"get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-legacy",
+ "operationId": "teams/get-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
},
"parameters": [
{
@@ -531703,15 +528427,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -531720,8 +528435,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -531850,13 +528565,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -531866,41 +528581,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -531959,10 +528689,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -531990,19 +528723,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -532026,20 +528762,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Update a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-legacy",
+ "operationId": "teams/update-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
},
"parameters": [
{
@@ -532059,37 +528795,29 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "body": "Do you like pineapples?"
+ "title": "Welcome to our first team post"
}
}
}
@@ -532102,8 +528830,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -532232,13 +528960,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -532248,41 +528976,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -532341,10 +529084,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -532372,19 +529118,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
"updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -532408,20 +529157,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-legacy",
+ "operationId": "teams/delete-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
},
"parameters": [
{
@@ -532441,15 +529190,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -532463,7 +529203,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
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 7517342b2..24d6a2155 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
@@ -1021,7 +1021,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &645
+ - &642
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -8795,7 +8795,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
- - &481
+ - &478
name: has
in: query
description: |-
@@ -8911,7 +8911,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &482
+ security_advisory: &479
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -9173,14 +9173,14 @@ paths:
format: date-time
readOnly: true
nullable: true
- auto_dismissed_at: &483
+ auto_dismissed_at: &480
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &484
+ dismissal_request: &481
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -10542,7 +10542,7 @@ paths:
properties:
action:
type: string
- discussion: &741
+ discussion: &736
title: Discussion
description: A Discussion in a repository.
type: object
@@ -10909,7 +10909,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &535
+ properties: &532
id:
type: integer
format: int64
@@ -11286,7 +11286,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &657
+ sub_issues_summary: &654
title: Sub-issues Summary
type: object
properties:
@@ -11306,7 +11306,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &658
+ issue_dependencies_summary: &655
title: Issue Dependencies Summary
type: object
properties:
@@ -11325,7 +11325,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &659
+ items: &656
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -11386,7 +11386,7 @@ paths:
- node_id
- data_type
- value
- required: &536
+ required: &533
- assignee
- closed_at
- comments
@@ -11424,7 +11424,7 @@ paths:
action:
type: string
issue: *74
- comment: &531
+ comment: &528
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -12143,7 +12143,7 @@ paths:
type: string
release:
allOf:
- - &590
+ - &587
title: Release
description: A release.
type: object
@@ -12214,7 +12214,7 @@ paths:
author: *4
assets:
type: array
- items: &591
+ items: &588
title: Release Asset
description: Data related to a release.
type: object
@@ -12805,7 +12805,7 @@ paths:
url:
type: string
format: uri
- user: &669
+ user: &664
title: Public User
description: Public User
type: object
@@ -16110,14 +16110,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &330
+ - &327
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &331
+ - &328
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -16179,7 +16179,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &334
+ '301': &331
description: Moved permanently
content:
application/json:
@@ -16201,7 +16201,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &564
+ - &561
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -16209,7 +16209,7 @@ paths:
schema:
type: boolean
default: false
- - &565
+ - &562
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -16219,7 +16219,7 @@ paths:
type: boolean
default: false
- *81
- - &566
+ - &563
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:
@@ -16693,7 +16693,7 @@ paths:
- url
- subscription_url
examples:
- default: &567
+ default: &564
value:
- id: '1'
repository:
@@ -17707,7 +17707,7 @@ paths:
- property_name
- value
examples:
- default: &573
+ default: &570
value:
- property_name: environment
value: production
@@ -17757,7 +17757,7 @@ paths:
required:
- properties
examples:
- default: &574
+ default: &571
value:
properties:
- property_name: environment
@@ -18318,7 +18318,7 @@ paths:
required: false
schema:
type: string
- - &718
+ - &713
name: model
description: The model name to query usage for. The name is not case sensitive.
in: query
@@ -18464,7 +18464,7 @@ paths:
parameters:
- *67
- *114
- - &719
+ - &714
name: month
description: If specified, only return results for a single month. The value
of `month` is an integer between `1` and `12`. If no year is specified the
@@ -18576,7 +18576,7 @@ paths:
- *114
- *116
- *115
- - &720
+ - &715
name: repository
description: The repository name to query for usage in the format owner/repository.
in: query
@@ -18584,7 +18584,7 @@ paths:
schema:
type: string
- *117
- - &721
+ - &716
name: sku
description: The SKU to query for usage.
in: query
@@ -19486,7 +19486,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &341
+ items: &338
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -20678,7 +20678,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &347
+ selected_actions_url: &344
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`
@@ -20761,7 +20761,7 @@ paths:
description: Response
content:
application/json:
- schema: &351
+ schema: &348
type: object
properties:
days:
@@ -20803,7 +20803,7 @@ paths:
required: true
content:
application/json:
- schema: &352
+ schema: &349
type: object
properties:
days:
@@ -20860,7 +20860,7 @@ paths:
required:
- approval_policy
examples:
- default: &353
+ default: &350
value:
approval_policy: first_time_contributors
'404': *6
@@ -20919,7 +20919,7 @@ paths:
description: Response
content:
application/json:
- schema: &354
+ schema: &351
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -20973,7 +20973,7 @@ paths:
required: true
content:
application/json:
- schema: &355
+ schema: &352
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -21608,7 +21608,7 @@ paths:
description: Response
content:
application/json:
- schema: &356
+ schema: &353
type: object
properties:
default_workflow_permissions: &144
@@ -21659,7 +21659,7 @@ paths:
required: false
content:
application/json:
- schema: &357
+ schema: &354
type: object
properties:
default_workflow_permissions: *144
@@ -22148,7 +22148,7 @@ paths:
type: array
items: *151
examples:
- default: &672
+ default: &667
value:
total_count: 1
repositories:
@@ -22790,7 +22790,7 @@ paths:
application/json:
schema:
type: array
- items: &358
+ items: &355
title: Runner Application
description: Runner Application
type: object
@@ -22815,7 +22815,7 @@ paths:
- download_url
- filename
examples:
- default: &359
+ default: &356
value:
- os: osx
architecture: x64
@@ -22901,7 +22901,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &360
+ '201': &357
description: Response
content:
application/json:
@@ -23012,7 +23012,7 @@ paths:
- token
- expires_at
examples:
- default: &361
+ default: &358
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -23051,7 +23051,7 @@ paths:
application/json:
schema: *155
examples:
- default: &362
+ default: &359
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -23085,7 +23085,7 @@ paths:
application/json:
schema: *153
examples:
- default: &363
+ default: &360
value:
id: 23
name: MBP
@@ -23311,7 +23311,7 @@ paths:
- *67
- *152
responses:
- '200': &364
+ '200': &361
description: Response
content:
application/json:
@@ -23368,7 +23368,7 @@ paths:
parameters:
- *67
- *152
- - &365
+ - &362
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -23498,7 +23498,7 @@ paths:
description: Response
content:
application/json:
- schema: &377
+ schema: &374
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -23527,7 +23527,7 @@ paths:
- key_id
- key
examples:
- default: &378
+ default: &375
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -23940,7 +23940,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *67
- - &346
+ - &343
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)."
@@ -25076,12 +25076,12 @@ paths:
required:
- subject_digests
examples:
- default: &700
+ default: &695
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &701
+ withPredicateType: &696
value:
subject_digests:
- sha256:abc123
@@ -25139,7 +25139,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &702
+ default: &697
value:
attestations_subject_digests:
- sha256:abc:
@@ -25488,7 +25488,7 @@ paths:
initiator:
type: string
examples:
- default: &391
+ default: &388
value:
attestations:
- bundle:
@@ -26417,7 +26417,7 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *67
- - &416
+ - &413
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`,
@@ -26427,7 +26427,7 @@ paths:
schema: &176
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &417
+ - &414
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
@@ -26450,7 +26450,7 @@ paths:
be returned.
in: query
required: false
- schema: &419
+ schema: &416
type: string
description: State of a code scanning alert.
enum:
@@ -26473,7 +26473,7 @@ paths:
be returned.
in: query
required: false
- schema: &420
+ schema: &417
type: string
description: Severity of a code scanning alert.
enum:
@@ -26507,7 +26507,7 @@ paths:
updated_at: *171
url: *172
html_url: *173
- instances_url: &421
+ instances_url: &418
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -26530,7 +26530,7 @@ paths:
required: *21
nullable: true
dismissed_at: *175
- dismissed_reason: &422
+ dismissed_reason: &419
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -26539,13 +26539,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &423
+ dismissed_comment: &420
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &424
+ rule: &421
type: object
properties:
id:
@@ -26598,7 +26598,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &425
+ tool: &422
type: object
properties:
name: *176
@@ -26608,26 +26608,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *177
- most_recent_instance: &426
+ most_recent_instance: &423
type: object
properties:
- ref: &418
+ ref: &415
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &436
+ analysis_key: &433
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
this includes the workflow filename and job name.
- environment: &437
+ environment: &434
type: string
description: Identifies the variable values associated with
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &438
+ category: &435
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -26641,7 +26641,7 @@ paths:
properties:
text:
type: string
- location: &439
+ location: &436
type: object
description: Describe a region within a file for the alert.
properties:
@@ -26662,7 +26662,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &440
+ items: &437
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -27951,7 +27951,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &452
+ properties: &449
name:
type: string
description: The name of the machine.
@@ -27993,7 +27993,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &453
+ required: &450
- name
- display_name
- operating_system
@@ -28861,7 +28861,7 @@ paths:
- updated_at
- visibility
examples:
- default: &454
+ default: &451
value:
total_count: 2
secrets:
@@ -28899,7 +28899,7 @@ paths:
description: Response
content:
application/json:
- schema: &455
+ schema: &452
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -28928,7 +28928,7 @@ paths:
- key_id
- key
examples:
- default: &456
+ default: &453
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -28960,7 +28960,7 @@ paths:
application/json:
schema: *186
examples:
- default: &458
+ default: &455
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -30573,7 +30573,7 @@ paths:
description: Response
content:
application/json:
- schema: &487
+ schema: &484
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -30590,7 +30590,7 @@ paths:
- key_id
- key
examples:
- default: &488
+ default: &485
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -32390,7 +32390,7 @@ paths:
application/json:
schema: *22
examples:
- default: &526
+ default: &523
value:
id: 1
account:
@@ -32615,7 +32615,7 @@ paths:
required: true
content:
application/json:
- schema: &527
+ schema: &524
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -33468,7 +33468,7 @@ paths:
application/json:
schema: *232
examples:
- default: &451
+ default: &448
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -34717,7 +34717,7 @@ paths:
parameters:
- *67
- *239
- - &685
+ - &680
name: repo_name
description: repo_name parameter
in: path
@@ -35756,7 +35756,7 @@ paths:
- nuget
- container
- *67
- - &686
+ - &681
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -35797,7 +35797,7 @@ paths:
default: *246
'403': *29
'401': *25
- '400': &688
+ '400': &683
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -37589,7 +37589,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &772
+ properties: &767
id:
type: number
description: The unique identifier of the status update.
@@ -37637,7 +37637,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &773
+ required: &768
- id
- node_id
- created_at
@@ -37851,7 +37851,7 @@ paths:
content:
oneOf:
- *74
- - &468
+ - &465
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -38080,7 +38080,7 @@ paths:
- review_comment
- self
author_association: *75
- auto_merge: &576
+ auto_merge: &573
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -38455,7 +38455,7 @@ paths:
- updated_at
- project_url
examples:
- default: &705
+ default: &700
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38632,7 +38632,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &706
+ items: &701
type: object
properties:
name:
@@ -38668,7 +38668,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &707
+ iteration_configuration: &702
type: object
description: The configuration for iteration fields.
properties:
@@ -38717,7 +38717,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &708
+ single_select_field: &703
summary: Create a single select field
value:
name: Priority
@@ -38744,7 +38744,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &709
+ iteration_field: &704
summary: Create an iteration field
value:
name: Sprint
@@ -38770,7 +38770,7 @@ paths:
application/json:
schema: *267
examples:
- text_field: &710
+ text_field: &705
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -38779,7 +38779,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &711
+ number_field: &706
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -38788,7 +38788,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &712
+ date_field: &707
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -38797,7 +38797,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &713
+ single_select_field: &708
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38831,7 +38831,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &714
+ iteration_field: &709
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -38877,7 +38877,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
parameters:
- *263
- - &715
+ - &710
name: field_id
description: The unique identifier of the field.
in: path
@@ -38892,7 +38892,7 @@ paths:
application/json:
schema: *267
examples:
- default: &716
+ default: &711
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -40014,7 +40014,7 @@ paths:
parameters:
- *263
- *67
- - &717
+ - &712
name: view_number
description: The number that identifies the project view.
in: path
@@ -40926,7 +40926,7 @@ paths:
description: Response
content:
application/json:
- schema: &333
+ schema: &330
title: Full Repository
description: Full Repository
type: object
@@ -41319,7 +41319,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &473
+ properties: &470
url:
type: string
format: uri
@@ -41335,7 +41335,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &474
+ required: &471
- url
- key
- name
@@ -41424,7 +41424,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &335
+ default: &332
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -41945,7 +41945,7 @@ paths:
- *67
- *17
- *19
- - &598
+ - &595
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -42226,7 +42226,7 @@ paths:
- repository_property
rules:
type: array
- items: &599
+ items: &596
title: Repository Rule
type: object
description: A repository rule.
@@ -42288,7 +42288,7 @@ paths:
type: string
enum:
- required_linear_history
- - &597
+ - &594
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -43184,7 +43184,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *67
- - &600
+ - &597
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
@@ -43199,7 +43199,7 @@ paths:
in: query
schema:
type: string
- - &601
+ - &598
name: time_period
description: |-
The time period to filter by.
@@ -43215,14 +43215,14 @@ paths:
- week
- month
default: day
- - &602
+ - &599
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
- - &603
+ - &600
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -43242,7 +43242,7 @@ paths:
description: Response
content:
application/json:
- schema: &604
+ schema: &601
title: Rule Suites
description: Response
type: array
@@ -43297,7 +43297,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &605
+ default: &602
value:
- id: 21
actor_id: 12
@@ -43341,7 +43341,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *67
- - &606
+ - &603
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -43357,7 +43357,7 @@ paths:
description: Response
content:
application/json:
- schema: &607
+ schema: &604
title: Rule Suite
description: Response
type: object
@@ -43456,7 +43456,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &608
+ default: &605
value:
id: 21
actor_id: 12
@@ -43702,7 +43702,7 @@ paths:
type: string
format: date-time
examples:
- default: &610
+ default: &607
value:
- version_id: 3
actor:
@@ -43755,7 +43755,7 @@ paths:
description: Response
content:
application/json:
- schema: &611
+ schema: &608
allOf:
- *310
- type: object
@@ -43827,7 +43827,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *67
- - &612
+ - &609
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -43838,7 +43838,7 @@ paths:
enum:
- open
- resolved
- - &613
+ - &610
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -43848,7 +43848,7 @@ paths:
required: false
schema:
type: string
- - &614
+ - &611
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -43857,7 +43857,7 @@ paths:
required: false
schema:
type: string
- - &615
+ - &612
name: assignee
in: query
description: Filters alerts by assignee. Use `*` to get all assigned alerts,
@@ -43876,7 +43876,7 @@ paths:
all-unassigned:
value: none
summary: Filter for all unassigned alerts
- - &616
+ - &613
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.
@@ -43891,7 +43891,7 @@ paths:
- *52
- *19
- *17
- - &617
+ - &614
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
@@ -43901,7 +43901,7 @@ paths:
required: false
schema:
type: string
- - &618
+ - &615
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
@@ -43911,7 +43911,7 @@ paths:
required: false
schema:
type: string
- - &619
+ - &616
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -43920,7 +43920,7 @@ paths:
required: false
schema:
type: string
- - &620
+ - &617
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43929,7 +43929,7 @@ paths:
schema:
type: boolean
default: false
- - &621
+ - &618
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43938,7 +43938,7 @@ paths:
schema:
type: boolean
default: false
- - &622
+ - &619
name: hide_secret
in: query
description: A boolean value representing whether or not to hide literal secrets
@@ -43973,14 +43973,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &623
+ state: &620
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: &624
+ resolution: &621
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -44087,8 +44087,8 @@ paths:
pull request.
'
- oneOf: &625
- - &627
+ oneOf: &622
+ - &624
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -44140,7 +44140,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &628
+ - &625
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -44195,7 +44195,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &629
+ - &626
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -44209,7 +44209,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &630
+ - &627
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -44223,7 +44223,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &631
+ - &628
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -44237,7 +44237,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &632
+ - &629
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -44251,7 +44251,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &633
+ - &630
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -44265,7 +44265,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &634
+ - &631
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -44279,7 +44279,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &635
+ - &632
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -44293,7 +44293,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &636
+ - &633
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -44307,7 +44307,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &637
+ - &634
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -44321,7 +44321,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &638
+ - &635
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -44335,7 +44335,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &639
+ - &636
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -44833,7 +44833,7 @@ paths:
application/json:
schema:
type: array
- items: &643
+ items: &640
description: A repository security advisory.
type: object
properties:
@@ -45124,7 +45124,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &644
+ default: &641
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -46963,13 +46963,6 @@ paths:
does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -47021,8 +47014,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -47035,7 +47026,7 @@ paths:
- updated_at
- url
examples:
- default: &661
+ default: &658
value:
- author:
login: octocat
@@ -47060,8 +47051,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -47171,8 +47160,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -47283,7 +47270,7 @@ paths:
application/json:
schema: *323
examples:
- default: &662
+ default: &659
value:
author:
login: octocat
@@ -47308,8 +47295,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -47364,410 +47349,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - *67
- - *68
- - *325
- - *52
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &326
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *76
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &663
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- headers:
- Link: *58
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: &327
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- - &328
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *327
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- - *328
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: &664
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- - *328
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47880,7 +47461,7 @@ paths:
description: Response
content:
application/json:
- schema: &329
+ schema: &326
title: Team Membership
description: Team Membership
type: object
@@ -47907,7 +47488,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &665
+ response-if-user-is-a-team-maintainer: &660
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -47970,9 +47551,9 @@ paths:
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- response-if-users-membership-with-team-is-now-pending: &666
+ response-if-users-membership-with-team-is-now-pending: &661
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -48079,14 +47660,14 @@ paths:
parameters:
- *67
- *68
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &667
+ schema: &662
title: Team Repository
description: A team's access to a repository.
type: object
@@ -48657,8 +48238,8 @@ paths:
parameters:
- *67
- *68
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -48705,8 +48286,8 @@ paths:
parameters:
- *67
- *68
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -48743,7 +48324,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: &668
+ response-if-child-teams-exist: &663
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -48897,7 +48478,7 @@ paths:
resources:
type: object
properties:
- core: &332
+ core: &329
title: Rate Limit
type: object
properties:
@@ -48914,21 +48495,21 @@ paths:
- remaining
- reset
- used
- graphql: *332
- search: *332
- code_search: *332
- source_import: *332
- integration_manifest: *332
- code_scanning_upload: *332
- actions_runner_registration: *332
- scim: *332
- dependency_snapshots: *332
- dependency_sbom: *332
- code_scanning_autofix: *332
+ graphql: *329
+ search: *329
+ code_search: *329
+ source_import: *329
+ integration_manifest: *329
+ code_scanning_upload: *329
+ actions_runner_registration: *329
+ scim: *329
+ dependency_snapshots: *329
+ dependency_sbom: *329
+ code_scanning_autofix: *329
required:
- core
- search
- rate: *332
+ rate: *329
required:
- rate
- resources
@@ -49033,14 +48614,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
default-response:
summary: Default response
@@ -49541,7 +49122,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *334
+ '301': *331
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -49559,8 +49140,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -49807,10 +49388,10 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
- '307': &336
+ default: *332
+ '307': &333
description: Temporary Redirect
content:
application/json:
@@ -49839,8 +49420,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -49862,7 +49443,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *336
+ '307': *333
'404': *6
'409': *51
x-github:
@@ -49886,11 +49467,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- - &369
+ - &366
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -49913,7 +49494,7 @@ paths:
type: integer
artifacts:
type: array
- items: &337
+ items: &334
title: Artifact
description: An artifact
type: object
@@ -49991,7 +49572,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &370
+ default: &367
value:
total_count: 2
artifacts:
@@ -50052,9 +49633,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *330
- - *331
- - &338
+ - *327
+ - *328
+ - &335
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -50066,7 +49647,7 @@ paths:
description: Response
content:
application/json:
- schema: *337
+ schema: *334
examples:
default:
value:
@@ -50104,9 +49685,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *330
- - *331
- - *338
+ - *327
+ - *328
+ - *335
responses:
'204':
description: Response
@@ -50130,9 +49711,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *330
- - *331
- - *338
+ - *327
+ - *328
+ - *335
- name: archive_format
in: path
required: true
@@ -50146,7 +49727,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': &530
+ '410': &527
description: Gone
content:
application/json:
@@ -50171,14 +49752,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &339
+ schema: &336
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -50211,13 +49792,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *339
+ schema: *336
examples:
selected_actions: *42
responses:
@@ -50246,14 +49827,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &340
+ schema: &337
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -50286,13 +49867,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *340
+ schema: *337
examples:
selected_actions: *44
responses:
@@ -50323,14 +49904,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *341
+ schema: *338
examples:
default:
value:
@@ -50356,11 +49937,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- - &342
+ - &339
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/`. To reference
@@ -50394,7 +49975,7 @@ paths:
description: Response
content:
application/json:
- schema: &343
+ schema: &340
title: Repository actions caches
description: Repository actions caches
type: object
@@ -50436,7 +50017,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &344
+ default: &341
value:
total_count: 1
actions_caches:
@@ -50468,23 +50049,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:
- - *330
- - *331
+ - *327
+ - *328
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *342
+ - *339
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: *344
+ default: *341
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50504,8 +50085,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:
- - *330
- - *331
+ - *327
+ - *328
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -50536,9 +50117,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *330
- - *331
- - &345
+ - *327
+ - *328
+ - &342
name: job_id
description: The unique identifier of the job.
in: path
@@ -50550,7 +50131,7 @@ paths:
description: Response
content:
application/json:
- schema: &373
+ schema: &370
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -50857,9 +50438,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *330
- - *331
- - *345
+ - *327
+ - *328
+ - *342
responses:
'302':
description: Response
@@ -50887,9 +50468,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *330
- - *331
- - *345
+ - *327
+ - *328
+ - *342
requestBody:
required: false
content:
@@ -50934,8 +50515,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Status response
@@ -50985,8 +50566,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -51049,8 +50630,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -51068,7 +50649,7 @@ paths:
type: integer
secrets:
type: array
- items: &375
+ items: &372
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -51088,7 +50669,7 @@ paths:
- created_at
- updated_at
examples:
- default: &376
+ default: &373
value:
total_count: 2
secrets:
@@ -51121,9 +50702,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *330
- - *331
- - *346
+ - *327
+ - *328
+ - *343
- *19
responses:
'200':
@@ -51140,7 +50721,7 @@ paths:
type: integer
variables:
type: array
- items: &379
+ items: &376
title: Actions Variable
type: object
properties:
@@ -51170,7 +50751,7 @@ paths:
- created_at
- updated_at
examples:
- default: &380
+ default: &377
value:
total_count: 2
variables:
@@ -51203,8 +50784,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51213,11 +50794,11 @@ paths:
schema:
type: object
properties:
- enabled: &348
+ enabled: &345
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *136
- selected_actions_url: *347
+ selected_actions_url: *344
sha_pinning_required: *137
required:
- enabled
@@ -51246,8 +50827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -51258,7 +50839,7 @@ paths:
schema:
type: object
properties:
- enabled: *348
+ enabled: *345
allowed_actions: *136
sha_pinning_required: *137
required:
@@ -51290,14 +50871,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &349
+ schema: &346
type: object
properties:
access_level:
@@ -51314,7 +50895,7 @@ paths:
required:
- access_level
examples:
- default: &350
+ default: &347
value:
access_level: organization
x-github:
@@ -51338,15 +50919,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *349
+ schema: *346
examples:
- default: *350
+ default: *347
responses:
'204':
description: Response
@@ -51370,14 +50951,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
default:
value:
@@ -51401,8 +50982,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Empty response for successful settings update
@@ -51412,7 +50993,7 @@ paths:
required: true
content:
application/json:
- schema: *352
+ schema: *349
examples:
default:
summary: Set retention days
@@ -51436,8 +51017,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51445,7 +51026,7 @@ paths:
application/json:
schema: *138
examples:
- default: *353
+ default: *350
'404': *6
x-github:
enabledForGitHubApps: true
@@ -51464,8 +51045,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -51499,14 +51080,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *354
+ schema: *351
examples:
default: *139
'403': *29
@@ -51528,13 +51109,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *355
+ schema: *352
examples:
default: *139
responses:
@@ -51560,8 +51141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51588,8 +51169,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -51621,14 +51202,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *356
+ schema: *353
examples:
default: *146
x-github:
@@ -51651,8 +51232,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Success response
@@ -51663,7 +51244,7 @@ paths:
required: true
content:
application/json:
- schema: *357
+ schema: *354
examples:
default: *146
x-github:
@@ -51692,8 +51273,8 @@ paths:
in: query
schema:
type: string
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -51737,8 +51318,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51746,9 +51327,9 @@ paths:
application/json:
schema:
type: array
- items: *358
+ items: *355
examples:
- default: *359
+ default: *356
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51770,8 +51351,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -51814,7 +51395,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *360
+ '201': *357
'404': *6
'422': *7
'409': *51
@@ -51845,8 +51426,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'201':
description: Response
@@ -51854,7 +51435,7 @@ paths:
application/json:
schema: *155
examples:
- default: *361
+ default: *358
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51882,8 +51463,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'201':
description: Response
@@ -51891,7 +51472,7 @@ paths:
application/json:
schema: *155
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51913,8 +51494,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
'200':
@@ -51923,7 +51504,7 @@ paths:
application/json:
schema: *153
examples:
- default: *363
+ default: *360
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51944,8 +51525,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
'204':
@@ -51972,8 +51553,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
'200': *157
@@ -51998,8 +51579,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
requestBody:
required: true
@@ -52048,8 +51629,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
requestBody:
required: true
@@ -52099,11 +51680,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
- '200': *364
+ '200': *361
'404': *6
x-github:
githubCloudOnly: false
@@ -52130,10 +51711,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
- - *365
+ - *362
responses:
'200': *157
'404': *6
@@ -52161,9 +51742,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *330
- - *331
- - &383
+ - *327
+ - *328
+ - &380
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.
@@ -52171,7 +51752,7 @@ paths:
required: false
schema:
type: string
- - &384
+ - &381
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -52179,7 +51760,7 @@ paths:
required: false
schema:
type: string
- - &385
+ - &382
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -52188,7 +51769,7 @@ paths:
required: false
schema:
type: string
- - &386
+ - &383
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
@@ -52215,7 +51796,7 @@ paths:
- pending
- *17
- *19
- - &387
+ - &384
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)."
@@ -52224,7 +51805,7 @@ paths:
schema:
type: string
format: date-time
- - &366
+ - &363
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -52233,13 +51814,13 @@ paths:
schema:
type: boolean
default: false
- - &388
+ - &385
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &389
+ - &386
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -52262,7 +51843,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &367
+ items: &364
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -52410,7 +51991,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &411
+ properties: &408
id:
type: string
description: SHA for the commit
@@ -52461,7 +52042,7 @@ paths:
- name
- email
nullable: true
- required: &412
+ required: &409
- id
- tree_id
- message
@@ -52508,7 +52089,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &390
+ default: &387
value:
total_count: 1
workflow_runs:
@@ -52744,24 +52325,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *330
- - *331
- - &368
+ - *327
+ - *328
+ - &365
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *366
+ - *363
responses:
'200':
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: &371
+ default: &368
value:
id: 30433642
name: Build
@@ -53002,9 +52583,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'204':
description: Response
@@ -53027,9 +52608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'200':
description: Response
@@ -53148,9 +52729,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:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'201':
description: Response
@@ -53183,12 +52764,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
- *17
- *19
- - *369
+ - *366
responses:
'200':
description: Response
@@ -53204,9 +52785,9 @@ paths:
type: integer
artifacts:
type: array
- items: *337
+ items: *334
examples:
- default: *370
+ default: *367
headers:
Link: *58
x-github:
@@ -53230,25 +52811,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *330
- - *331
- - *368
- - &372
+ - *327
+ - *328
+ - *365
+ - &369
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *366
+ - *363
responses:
'200':
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: *371
+ default: *368
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53271,10 +52852,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *330
- - *331
- - *368
- - *372
+ - *327
+ - *328
+ - *365
+ - *369
- *17
- *19
responses:
@@ -53292,9 +52873,9 @@ paths:
type: integer
jobs:
type: array
- items: *373
+ items: *370
examples:
- default: &374
+ default: &371
value:
total_count: 1
jobs:
@@ -53407,10 +52988,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *330
- - *331
- - *368
- - *372
+ - *327
+ - *328
+ - *365
+ - *369
responses:
'302':
description: Response
@@ -53438,9 +53019,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'202':
description: Response
@@ -53473,9 +53054,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:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: true
content:
@@ -53542,9 +53123,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'202':
description: Response
@@ -53577,9 +53158,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
- 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
@@ -53609,9 +53190,9 @@ paths:
type: integer
jobs:
type: array
- items: *373
+ items: *370
examples:
- default: *374
+ default: *371
headers:
Link: *58
x-github:
@@ -53636,9 +53217,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'302':
description: Response
@@ -53665,9 +53246,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'204':
description: Response
@@ -53694,9 +53275,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'200':
description: Response
@@ -53756,7 +53337,7 @@ paths:
items:
type: object
properties:
- type: &496
+ type: &493
type: string
description: The type of reviewer.
enum:
@@ -53841,9 +53422,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: true
content:
@@ -53890,7 +53471,7 @@ paths:
application/json:
schema:
type: array
- items: &491
+ items: &488
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -53996,7 +53577,7 @@ paths:
- created_at
- updated_at
examples:
- default: &492
+ default: &489
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -54052,9 +53633,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: false
content:
@@ -54098,9 +53679,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: false
content:
@@ -54153,9 +53734,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'200':
description: Response
@@ -54292,8 +53873,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -54311,9 +53892,9 @@ paths:
type: integer
secrets:
type: array
- items: *375
+ items: *372
examples:
- default: *376
+ default: *373
headers:
Link: *58
x-github:
@@ -54338,16 +53919,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -54369,17 +53950,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *375
+ schema: *372
examples:
- default: &509
+ default: &506
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -54405,8 +53986,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
requestBody:
required: true
@@ -54464,8 +54045,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'204':
@@ -54491,9 +54072,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *330
- - *331
- - *346
+ - *327
+ - *328
+ - *343
- *19
responses:
'200':
@@ -54510,9 +54091,9 @@ paths:
type: integer
variables:
type: array
- items: *379
+ items: *376
examples:
- default: *380
+ default: *377
headers:
Link: *58
x-github:
@@ -54535,8 +54116,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -54588,17 +54169,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *379
+ schema: *376
examples:
- default: &510
+ default: &507
value:
name: USERNAME
value: octocat
@@ -54624,8 +54205,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
requestBody:
required: true
@@ -54668,8 +54249,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
responses:
'204':
@@ -54695,8 +54276,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -54714,7 +54295,7 @@ paths:
type: integer
workflows:
type: array
- items: &381
+ items: &378
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -54821,9 +54402,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *330
- - *331
- - &382
+ - *327
+ - *328
+ - &379
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -54838,7 +54419,7 @@ paths:
description: Response
content:
application/json:
- schema: *381
+ schema: *378
examples:
default:
value:
@@ -54871,9 +54452,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'204':
description: Response
@@ -54898,9 +54479,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'204':
description: Response
@@ -54951,9 +54532,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'204':
description: Response
@@ -54980,19 +54561,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *330
- - *331
+ - *327
+ - *328
+ - *379
+ - *380
+ - *381
- *382
- *383
+ - *17
+ - *19
- *384
+ - *363
- *385
- *386
- - *17
- - *19
- - *387
- - *366
- - *388
- - *389
responses:
'200':
description: Response
@@ -55008,9 +54589,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *367
+ items: *364
examples:
- default: *390
+ default: *387
headers:
Link: *58
x-github:
@@ -55042,9 +54623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'200':
description: Response
@@ -55105,8 +54686,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *52
- *17
- *45
@@ -55270,8 +54851,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -55308,8 +54889,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: assignee
in: path
required: true
@@ -55345,8 +54926,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#create-an-attestation
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -55458,8 +55039,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#list-attestations
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *45
- *46
@@ -55516,7 +55097,7 @@ paths:
initiator:
type: string
examples:
- default: *391
+ default: *388
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -55536,8 +55117,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -55545,7 +55126,7 @@ paths:
application/json:
schema:
type: array
- items: &392
+ items: &389
title: Autolink reference
description: An autolink reference.
type: object
@@ -55599,8 +55180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -55639,9 +55220,9 @@ paths:
description: response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: &393
+ default: &390
value:
id: 1
key_prefix: TICKET-
@@ -55672,9 +55253,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *330
- - *331
- - &394
+ - *327
+ - *328
+ - &391
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -55686,9 +55267,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: *393
+ default: *390
'404': *6
x-github:
githubCloudOnly: false
@@ -55708,9 +55289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *330
- - *331
- - *394
+ - *327
+ - *328
+ - *391
responses:
'204':
description: Response
@@ -55734,8 +55315,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response if Dependabot is enabled
@@ -55783,8 +55364,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -55805,8 +55386,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -55826,8 +55407,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -55865,7 +55446,7 @@ paths:
- url
protected:
type: boolean
- protection: &396
+ protection: &393
title: Branch Protection
description: Branch Protection
type: object
@@ -55907,7 +55488,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &399
+ enforce_admins: &396
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -55922,7 +55503,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &401
+ required_pull_request_reviews: &398
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -55998,7 +55579,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &398
+ restrictions: &395
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -56275,9 +55856,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *330
- - *331
- - &397
+ - *327
+ - *328
+ - &394
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).
@@ -56291,14 +55872,14 @@ paths:
description: Response
content:
application/json:
- schema: &407
+ schema: &404
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &464
+ commit: &461
title: Commit
description: Commit
type: object
@@ -56332,7 +55913,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &395
+ properties: &392
name:
type: string
example: '"Chris Wanstrath"'
@@ -56348,7 +55929,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *395
+ properties: *392
nullable: true
message:
type: string
@@ -56369,7 +55950,7 @@ paths:
required:
- sha
- url
- verification: &516
+ verification: &513
title: Verification
type: object
properties:
@@ -56439,7 +56020,7 @@ paths:
type: integer
files:
type: array
- items: &477
+ items: &474
title: Diff Entry
description: Diff Entry
type: object
@@ -56523,7 +56104,7 @@ paths:
- self
protected:
type: boolean
- protection: *396
+ protection: *393
protection_url:
type: string
format: uri
@@ -56630,7 +56211,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *334
+ '301': *331
'404': *6
x-github:
githubCloudOnly: false
@@ -56652,15 +56233,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
default:
value:
@@ -56854,9 +56435,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -57111,7 +56692,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &404
+ required_status_checks: &401
title: Status Check Policy
description: Status Check Policy
type: object
@@ -57263,7 +56844,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *398
+ restrictions: *395
required_conversation_resolution:
type: object
properties:
@@ -57375,9 +56956,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57402,17 +56983,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: &400
+ default: &397
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -57434,17 +57015,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: *400
+ default: *397
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57463,9 +57044,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57490,17 +57071,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: &402
+ default: &399
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -57596,9 +57177,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -57696,9 +57277,9 @@ paths:
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *15
x-github:
githubCloudOnly: false
@@ -57719,9 +57300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57748,17 +57329,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: &403
+ default: &400
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -57781,17 +57362,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: *403
+ default: *400
'404': *6
x-github:
githubCloudOnly: false
@@ -57811,9 +57392,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57838,17 +57419,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: &405
+ default: &402
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -57874,9 +57455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -57928,9 +57509,9 @@ paths:
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'404': *6
'422': *15
x-github:
@@ -57952,9 +57533,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57978,9 +57559,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58014,9 +57595,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58083,9 +57664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58149,9 +57730,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
content:
application/json:
@@ -58217,15 +57798,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
default:
value:
@@ -58316,9 +57897,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -58341,9 +57922,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58353,7 +57934,7 @@ paths:
type: array
items: *5
examples:
- default: &406
+ default: &403
value:
- id: 1
slug: octoapp
@@ -58410,9 +57991,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58446,7 +58027,7 @@ paths:
type: array
items: *5
examples:
- default: *406
+ default: *403
'422': *15
x-github:
githubCloudOnly: false
@@ -58467,9 +58048,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58503,7 +58084,7 @@ paths:
type: array
items: *5
examples:
- default: *406
+ default: *403
'422': *15
x-github:
githubCloudOnly: false
@@ -58524,9 +58105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58560,7 +58141,7 @@ paths:
type: array
items: *5
examples:
- default: *406
+ default: *403
'422': *15
x-github:
githubCloudOnly: false
@@ -58582,9 +58163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58614,9 +58195,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58675,9 +58256,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58736,9 +58317,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
content:
application/json:
@@ -58797,9 +58378,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58833,9 +58414,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58893,9 +58474,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58953,9 +58534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -59015,9 +58596,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -59039,7 +58620,7 @@ paths:
description: Response
content:
application/json:
- schema: *407
+ schema: *404
examples:
default:
value:
@@ -59155,8 +58736,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -59435,7 +59016,7 @@ paths:
description: Response
content:
application/json:
- schema: &408
+ schema: &405
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -59555,7 +59136,7 @@ paths:
check.
type: array
items: *79
- deployment: &730
+ deployment: &725
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -59835,9 +59416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *330
- - *331
- - &409
+ - *327
+ - *328
+ - &406
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -59849,9 +59430,9 @@ paths:
description: Response
content:
application/json:
- schema: *408
+ schema: *405
examples:
- default: &410
+ default: &407
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -59951,9 +59532,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *330
- - *331
- - *409
+ - *327
+ - *328
+ - *406
requestBody:
required: true
content:
@@ -60193,9 +59774,9 @@ paths:
description: Response
content:
application/json:
- schema: *408
+ schema: *405
examples:
- default: *410
+ default: *407
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60215,9 +59796,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *330
- - *331
- - *409
+ - *327
+ - *328
+ - *406
- *17
- *19
responses:
@@ -60312,9 +59893,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *330
- - *331
- - *409
+ - *327
+ - *328
+ - *406
responses:
'201':
description: Response
@@ -60358,8 +59939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -60381,7 +59962,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &413
+ schema: &410
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -60467,12 +60048,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &756
+ head_commit: &751
title: Simple Commit
description: A commit.
type: object
- properties: *411
- required: *412
+ properties: *408
+ required: *409
latest_check_runs_count:
type: integer
check_runs_url:
@@ -60500,7 +60081,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &414
+ default: &411
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -60791,9 +60372,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *413
+ schema: *410
examples:
- default: *414
+ default: *411
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60812,8 +60393,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -61122,9 +60703,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *330
- - *331
- - &415
+ - *327
+ - *328
+ - &412
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -61136,9 +60717,9 @@ paths:
description: Response
content:
application/json:
- schema: *413
+ schema: *410
examples:
- default: *414
+ default: *411
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61161,17 +60742,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *330
- - *331
- - *415
- - &470
+ - *327
+ - *328
+ - *412
+ - &467
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &471
+ - &468
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -61210,9 +60791,9 @@ paths:
type: integer
check_runs:
type: array
- items: *408
+ items: *405
examples:
- default: &472
+ default: &469
value:
total_count: 1
check_runs:
@@ -61314,9 +60895,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *330
- - *331
- - *415
+ - *327
+ - *328
+ - *412
responses:
'201':
description: Response
@@ -61349,21 +60930,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *330
- - *331
- - *416
- - *417
+ - *327
+ - *328
+ - *413
+ - *414
- *19
- *17
- - &434
+ - &431
name: ref
description: The Git reference for the results you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
in: query
required: false
- schema: *418
- - &435
+ schema: *415
+ - &432
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -61388,13 +60969,13 @@ paths:
be returned.
in: query
required: false
- schema: *419
+ schema: *416
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *420
+ schema: *417
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -61418,7 +60999,7 @@ paths:
updated_at: *171
url: *172
html_url: *173
- instances_url: *421
+ instances_url: *418
state: *178
fixed_at: *174
dismissed_by:
@@ -61429,11 +61010,11 @@ paths:
required: *21
nullable: true
dismissed_at: *175
- dismissed_reason: *422
- dismissed_comment: *423
- rule: *424
- tool: *425
- most_recent_instance: *426
+ dismissed_reason: *419
+ dismissed_comment: *420
+ rule: *421
+ tool: *422
+ most_recent_instance: *423
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61559,7 +61140,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &427
+ '403': &424
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -61586,9 +61167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *330
- - *331
- - &428
+ - *327
+ - *328
+ - &425
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -61602,7 +61183,7 @@ paths:
description: Response
content:
application/json:
- schema: &429
+ schema: &426
type: object
properties:
number: *169
@@ -61610,7 +61191,7 @@ paths:
updated_at: *171
url: *172
html_url: *173
- instances_url: *421
+ instances_url: *418
state: *178
fixed_at: *174
dismissed_by:
@@ -61621,8 +61202,8 @@ paths:
required: *21
nullable: true
dismissed_at: *175
- dismissed_reason: *422
- dismissed_comment: *423
+ dismissed_reason: *419
+ dismissed_comment: *420
rule:
type: object
properties:
@@ -61676,8 +61257,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *425
- most_recent_instance: *426
+ tool: *422
+ most_recent_instance: *423
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61776,7 +61357,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -61796,9 +61377,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
requestBody:
required: true
content:
@@ -61813,8 +61394,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *422
- dismissed_comment: *423
+ dismissed_reason: *419
+ dismissed_comment: *420
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -61842,7 +61423,7 @@ paths:
description: Response
content:
application/json:
- schema: *429
+ schema: *426
examples:
default:
value:
@@ -61918,7 +61499,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &433
+ '403': &430
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -61945,15 +61526,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:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
responses:
'200':
description: Response
content:
application/json:
- schema: &430
+ schema: &427
type: object
properties:
status:
@@ -61979,13 +61560,13 @@ paths:
- description
- started_at
examples:
- default: &431
+ default: &428
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &432
+ '400': &429
description: Bad Request
content:
application/json:
@@ -61996,7 +61577,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': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62021,29 +61602,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:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
responses:
'200':
description: OK
content:
application/json:
- schema: *430
+ schema: *427
examples:
- default: *431
+ default: *428
'202':
description: Accepted
content:
application/json:
- schema: *430
+ schema: *427
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *432
+ '400': *429
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -62075,9 +61656,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:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
requestBody:
required: false
content:
@@ -62122,8 +61703,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *432
- '403': *433
+ '400': *429
+ '403': *430
'404': *6
'422':
description: Unprocessable Entity
@@ -62147,13 +61728,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
- *19
- *17
- - *434
- - *435
+ - *431
+ - *432
responses:
'200':
description: Response
@@ -62164,10 +61745,10 @@ paths:
items:
type: object
properties:
- ref: *418
- analysis_key: *436
- environment: *437
- category: *438
+ ref: *415
+ analysis_key: *433
+ environment: *434
+ category: *435
state:
type: string
description: State of a code scanning alert instance.
@@ -62182,7 +61763,7 @@ paths:
properties:
text:
type: string
- location: *439
+ location: *436
html_url:
type: string
classifications:
@@ -62190,7 +61771,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: *440
+ items: *437
examples:
default:
value:
@@ -62229,7 +61810,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62263,25 +61844,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *330
- - *331
- - *416
- - *417
+ - *327
+ - *328
+ - *413
+ - *414
- *19
- *17
- - *435
+ - *432
- name: ref
in: query
description: The Git reference for the analyses you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *418
+ schema: *415
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &441
+ schema: &438
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -62302,23 +61883,23 @@ paths:
application/json:
schema:
type: array
- items: &442
+ items: &439
type: object
properties:
- ref: *418
- commit_sha: &450
+ ref: *415
+ commit_sha: &447
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: *436
+ analysis_key: *433
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *438
+ category: *435
error:
type: string
example: error reading field xyz
@@ -62342,8 +61923,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *441
- tool: *425
+ sarif_id: *438
+ tool: *422
deletable:
type: boolean
warning:
@@ -62404,7 +61985,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62440,8 +62021,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:
- - *330
- - *331
+ - *327
+ - *328
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62454,7 +62035,7 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
response:
summary: application/json response
@@ -62508,7 +62089,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *427
+ '403': *424
'404': *6
'422':
description: Response if analysis could not be processed
@@ -62595,8 +62176,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:
- - *330
- - *331
+ - *327
+ - *328
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62649,7 +62230,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': *433
+ '403': *430
'404': *6
'503': *112
x-github:
@@ -62671,8 +62252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -62680,7 +62261,7 @@ paths:
application/json:
schema:
type: array
- items: &443
+ items: &440
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -62791,7 +62372,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': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62820,8 +62401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: language
in: path
description: The language of the CodeQL database.
@@ -62833,7 +62414,7 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
default:
value:
@@ -62865,9 +62446,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': &479
+ '302': &476
description: Found
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62889,8 +62470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: language
in: path
description: The language of the CodeQL database.
@@ -62900,7 +62481,7 @@ paths:
responses:
'204':
description: Response
- '403': *433
+ '403': *430
'404': *6
'503': *112
x-github:
@@ -62928,8 +62509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -62938,7 +62519,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &444
+ language: &441
type: string
description: The language targeted by the CodeQL query
enum:
@@ -63018,7 +62599,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &448
+ schema: &445
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -63028,7 +62609,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *57
actor: *4
- query_language: *444
+ query_language: *441
query_pack_url:
type: string
description: The download url for the query pack.
@@ -63075,7 +62656,7 @@ paths:
items:
type: object
properties:
- repository: &445
+ repository: &442
title: Repository Identifier
description: Repository Identifier
type: object
@@ -63111,7 +62692,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &449
+ analysis_status: &446
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -63143,7 +62724,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &446
+ access_mismatch_repos: &443
type: object
properties:
repository_count:
@@ -63157,7 +62738,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: *445
+ items: *442
required:
- repository_count
- repositories
@@ -63179,8 +62760,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *446
- over_limit_repos: *446
+ no_codeql_db_repos: *443
+ over_limit_repos: *443
required:
- access_mismatch_repos
- not_found_repos
@@ -63196,7 +62777,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &447
+ value: &444
summary: Default response
value:
id: 1
@@ -63342,10 +62923,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *447
+ value: *444
repository_lists:
summary: Response for a successful variant analysis submission
- value: *447
+ value: *444
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -63373,8 +62954,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:
- - *330
- - *331
+ - *327
+ - *328
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -63386,9 +62967,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: *447
+ default: *444
'404': *6
'503': *112
x-github:
@@ -63411,7 +62992,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:
- - *330
+ - *327
- name: repo
in: path
description: The name of the controller repository.
@@ -63446,7 +63027,7 @@ paths:
type: object
properties:
repository: *57
- analysis_status: *449
+ analysis_status: *446
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -63571,8 +63152,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -63657,7 +63238,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -63678,8 +63259,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -63771,7 +63352,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *433
+ '403': *430
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -63842,8 +63423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -63851,7 +63432,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *450
+ commit_sha: *447
ref:
type: string
description: |-
@@ -63909,7 +63490,7 @@ paths:
schema:
type: object
properties:
- id: *441
+ id: *438
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -63923,7 +63504,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': *433
+ '403': *430
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -63946,8 +63527,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -63993,7 +63574,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': *427
+ '403': *424
'404':
description: Not Found if the sarif id does not match any upload
'503': *112
@@ -64018,8 +63599,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -64100,8 +63681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -64221,8 +63802,8 @@ paths:
parameters:
- *17
- *19
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -64536,8 +64117,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -64602,7 +64183,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -64610,7 +64191,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'400': *14
'401': *25
'403': *29
@@ -64639,8 +64220,8 @@ paths:
parameters:
- *17
- *19
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -64704,8 +64285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -64740,14 +64321,14 @@ paths:
type: integer
machines:
type: array
- items: &675
+ items: &670
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *452
- required: *453
+ properties: *449
+ required: *450
examples:
- default: &676
+ default: &671
value:
total_count: 2
machines:
@@ -64787,8 +64368,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -64872,8 +64453,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:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -64939,8 +64520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -64958,7 +64539,7 @@ paths:
type: integer
secrets:
type: array
- items: &457
+ items: &454
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -64978,7 +64559,7 @@ paths:
- created_at
- updated_at
examples:
- default: *454
+ default: *451
headers:
Link: *58
x-github:
@@ -65001,16 +64582,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *455
+ schema: *452
examples:
- default: *456
+ default: *453
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -65030,17 +64611,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65060,8 +64641,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
requestBody:
required: true
@@ -65114,8 +64695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'204':
@@ -65144,8 +64725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -65187,7 +64768,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &459
+ properties: &456
login:
type: string
example: octocat
@@ -65280,7 +64861,7 @@ paths:
user_view_type:
type: string
example: public
- required: &460
+ required: &457
- avatar_url
- events_url
- followers_url
@@ -65354,8 +64935,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
responses:
'204':
@@ -65402,8 +64983,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
requestBody:
required: false
@@ -65430,7 +65011,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &529
+ schema: &526
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -65659,8 +65240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
responses:
'204':
@@ -65692,8 +65273,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
responses:
'200':
@@ -65714,8 +65295,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *459
- required: *460
+ properties: *456
+ required: *457
nullable: true
required:
- permission
@@ -65770,8 +65351,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -65781,7 +65362,7 @@ paths:
application/json:
schema:
type: array
- items: &461
+ items: &458
title: Commit Comment
description: Commit Comment
type: object
@@ -65839,7 +65420,7 @@ paths:
- created_at
- updated_at
examples:
- default: &466
+ default: &463
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65898,17 +65479,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'200':
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: &467
+ default: &464
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65965,8 +65546,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -65989,7 +65570,7 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
default:
value:
@@ -66040,8 +65621,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'204':
@@ -66063,8 +65644,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -66091,7 +65672,7 @@ paths:
application/json:
schema:
type: array
- items: &462
+ items: &459
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -66134,7 +65715,7 @@ paths:
- content
- created_at
examples:
- default: &533
+ default: &530
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -66179,8 +65760,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -66213,9 +65794,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: &463
+ default: &460
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -66244,9 +65825,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -66268,10 +65849,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- - &534
+ - &531
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -66326,8 +65907,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -66383,9 +65964,9 @@ paths:
application/json:
schema:
type: array
- items: *464
+ items: *461
examples:
- default: &583
+ default: &580
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -66479,9 +66060,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *330
- - *331
- - &465
+ - *327
+ - *328
+ - &462
name: commit_sha
description: The SHA of the commit.
in: path
@@ -66553,9 +66134,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
- *17
- *19
responses:
@@ -66565,9 +66146,9 @@ paths:
application/json:
schema:
type: array
- items: *461
+ items: *458
examples:
- default: *466
+ default: *463
headers:
Link: *58
x-github:
@@ -66595,9 +66176,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
requestBody:
required: true
content:
@@ -66632,9 +66213,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *467
+ default: *464
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -66662,9 +66243,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
- *17
- *19
responses:
@@ -66674,9 +66255,9 @@ paths:
application/json:
schema:
type: array
- items: *468
+ items: *465
examples:
- default: &575
+ default: &572
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -67213,11 +66794,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *19
- *17
- - &469
+ - &466
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)"
@@ -67232,9 +66813,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: &560
+ default: &557
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -67347,11 +66928,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *330
- - *331
- - *469
- - *470
- - *471
+ - *327
+ - *328
+ - *466
+ - *467
+ - *468
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -67385,9 +66966,9 @@ paths:
type: integer
check_runs:
type: array
- items: *408
+ items: *405
examples:
- default: *472
+ default: *469
headers:
Link: *58
x-github:
@@ -67412,9 +66993,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *330
- - *331
- - *469
+ - *327
+ - *328
+ - *466
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -67422,7 +67003,7 @@ paths:
schema:
type: integer
example: 1
- - *470
+ - *467
- *17
- *19
responses:
@@ -67440,7 +67021,7 @@ paths:
type: integer
check_suites:
type: array
- items: *413
+ items: *410
examples:
default:
value:
@@ -67640,9 +67221,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *330
- - *331
- - *469
+ - *327
+ - *328
+ - *466
- *17
- *19
responses:
@@ -67840,9 +67421,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *330
- - *331
- - *469
+ - *327
+ - *328
+ - *466
- *17
- *19
responses:
@@ -67852,7 +67433,7 @@ paths:
application/json:
schema:
type: array
- items: &648
+ items: &645
title: Status
description: The status of a commit.
type: object
@@ -67933,7 +67514,7 @@ paths:
site_admin: false
headers:
Link: *58
- '301': *334
+ '301': *331
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67961,8 +67542,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -67991,20 +67572,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *473
- required: *474
+ properties: *470
+ required: *471
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &475
+ properties: &472
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &476
+ required: &473
- url
- html_url
nullable: true
@@ -68018,26 +67599,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
readme:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
required:
- code_of_conduct
@@ -68164,8 +67745,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *19
- *17
- name: basehead
@@ -68208,8 +67789,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *464
- merge_base_commit: *464
+ base_commit: *461
+ merge_base_commit: *461
status:
type: string
enum:
@@ -68229,10 +67810,10 @@ paths:
example: 6
commits:
type: array
- items: *464
+ items: *461
files:
type: array
- items: *477
+ items: *474
required:
- url
- html_url
@@ -68518,8 +68099,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: path
description: path parameter
in: path
@@ -68662,7 +68243,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &478
+ response-if-content-is-a-file: &475
summary: Response if content is a file
value:
type: file
@@ -68794,7 +68375,7 @@ paths:
- size
- type
- url
- - &588
+ - &585
title: Content File
description: Content File
type: object
@@ -68995,7 +68576,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *478
+ response-if-content-is-a-file: *475
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -69064,7 +68645,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *479
+ '302': *476
'304': *37
x-github:
githubCloudOnly: false
@@ -69087,8 +68668,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: path
description: path parameter
in: path
@@ -69181,7 +68762,7 @@ paths:
description: Response
content:
application/json:
- schema: &480
+ schema: &477
title: File Commit
description: File Commit
type: object
@@ -69333,7 +68914,7 @@ paths:
description: Response
content:
application/json:
- schema: *480
+ schema: *477
examples:
example-for-creating-a-file:
value:
@@ -69387,7 +68968,7 @@ paths:
schema:
oneOf:
- *3
- - &511
+ - &508
description: Repository rule violation was detected
type: object
properties:
@@ -69408,7 +68989,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &640
+ placeholder_id: &637
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -69440,8 +69021,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: path
description: path parameter
in: path
@@ -69502,7 +69083,7 @@ paths:
description: Response
content:
application/json:
- schema: *480
+ schema: *477
examples:
default:
value:
@@ -69557,8 +69138,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -69681,8 +69262,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *190
- *191
- *192
@@ -69694,7 +69275,7 @@ paths:
schema:
type: string
- *194
- - *481
+ - *478
- *195
- *196
- *52
@@ -69715,7 +69296,7 @@ paths:
application/json:
schema:
type: array
- items: &485
+ items: &482
type: object
description: A Dependabot alert.
properties:
@@ -69761,7 +69342,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *482
+ security_advisory: *479
security_vulnerability: *56
url: *172
html_url: *173
@@ -69792,8 +69373,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *174
- auto_dismissed_at: *483
- dismissal_request: *484
+ auto_dismissed_at: *480
+ dismissal_request: *481
required:
- number
- state
@@ -70023,9 +69604,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *330
- - *331
- - &486
+ - *327
+ - *328
+ - &483
name: alert_number
in: path
description: |-
@@ -70040,7 +69621,7 @@ paths:
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
default:
value:
@@ -70153,9 +69734,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *330
- - *331
- - *486
+ - *327
+ - *328
+ - *483
requestBody:
required: true
content:
@@ -70200,7 +69781,7 @@ paths:
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
default:
value:
@@ -70329,8 +69910,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -70348,7 +69929,7 @@ paths:
type: integer
secrets:
type: array
- items: &489
+ items: &486
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -70401,16 +69982,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *487
+ schema: *484
examples:
- default: *488
+ default: *485
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70430,15 +70011,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *489
+ schema: *486
examples:
default:
value:
@@ -70464,8 +70045,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
requestBody:
required: true
@@ -70518,8 +70099,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'204':
@@ -70542,8 +70123,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:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -70703,8 +70284,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -70943,8 +70524,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -71019,7 +70600,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &490
+ metadata: &487
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -71052,7 +70633,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *490
+ metadata: *487
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -71065,7 +70646,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *490
+ metadata: *487
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -71194,8 +70775,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -71235,9 +70816,9 @@ paths:
application/json:
schema:
type: array
- items: *491
+ items: *488
examples:
- default: *492
+ default: *489
headers:
Link: *58
x-github:
@@ -71303,8 +70884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -71385,7 +70966,7 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
simple-example:
summary: Simple example
@@ -71458,9 +71039,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *330
- - *331
- - &493
+ - *327
+ - *328
+ - &490
name: deployment_id
description: deployment_id parameter
in: path
@@ -71472,7 +71053,7 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
default:
value:
@@ -71537,9 +71118,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
responses:
'204':
description: Response
@@ -71561,9 +71142,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
- *17
- *19
responses:
@@ -71573,7 +71154,7 @@ paths:
application/json:
schema:
type: array
- items: &494
+ items: &491
title: Deployment Status
description: The status of a deployment.
type: object
@@ -71734,9 +71315,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
requestBody:
required: true
content:
@@ -71811,9 +71392,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: &495
+ default: &492
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -71869,9 +71450,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
- name: status_id
in: path
required: true
@@ -71882,9 +71463,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: *495
+ default: *492
'404': *6
x-github:
githubCloudOnly: false
@@ -71909,8 +71490,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -71967,8 +71548,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -71985,7 +71566,7 @@ paths:
type: integer
environments:
type: array
- items: &497
+ items: &494
title: Environment
description: Details of a deployment environment
type: object
@@ -72037,7 +71618,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &499
+ wait_timer: &496
type: integer
example: 30
description: The amount of time to delay a job after
@@ -72074,7 +71655,7 @@ paths:
items:
type: object
properties:
- type: *496
+ type: *493
reviewer:
anyOf:
- *4
@@ -72098,7 +71679,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &500
+ deployment_branch_policy: &497
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -72214,9 +71795,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *330
- - *331
- - &498
+ - *327
+ - *328
+ - &495
name: environment_name
in: path
required: true
@@ -72229,9 +71810,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &501
+ default: &498
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -72315,9 +71896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
requestBody:
required: false
content:
@@ -72326,7 +71907,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *499
+ wait_timer: *496
prevent_self_review:
type: boolean
example: false
@@ -72343,13 +71924,13 @@ paths:
items:
type: object
properties:
- type: *496
+ type: *493
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *500
+ deployment_branch_policy: *497
additionalProperties: false
examples:
default:
@@ -72369,9 +71950,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *501
+ default: *498
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -72395,9 +71976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
responses:
'204':
description: Default response
@@ -72422,9 +72003,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *17
- *19
responses:
@@ -72442,7 +72023,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &502
+ items: &499
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -72499,9 +72080,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
requestBody:
required: true
content:
@@ -72547,9 +72128,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- example-wildcard: &503
+ example-wildcard: &500
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -72591,10 +72172,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
- - &504
+ - *327
+ - *328
+ - *495
+ - &501
name: branch_policy_id
in: path
required: true
@@ -72606,9 +72187,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: *503
+ default: *500
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72627,10 +72208,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
- - *504
+ - *327
+ - *328
+ - *495
+ - *501
requestBody:
required: true
content:
@@ -72658,9 +72239,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: *503
+ default: *500
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72679,10 +72260,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
- - *504
+ - *327
+ - *328
+ - *495
+ - *501
responses:
'204':
description: Response
@@ -72707,9 +72288,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *498
- - *331
- - *330
+ - *495
+ - *328
+ - *327
responses:
'200':
description: List of deployment protection rules
@@ -72725,7 +72306,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &505
+ items: &502
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -72744,7 +72325,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &506
+ app: &503
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -72843,9 +72424,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:
- - *498
- - *331
- - *330
+ - *495
+ - *328
+ - *327
requestBody:
content:
application/json:
@@ -72866,9 +72447,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *505
+ schema: *502
examples:
- default: &507
+ default: &504
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -72903,9 +72484,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:
- - *498
- - *331
- - *330
+ - *495
+ - *328
+ - *327
- *19
- *17
responses:
@@ -72924,7 +72505,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *506
+ items: *503
examples:
default:
value:
@@ -72959,10 +72540,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *330
- - *331
- - *498
- - &508
+ - *327
+ - *328
+ - *495
+ - &505
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -72974,9 +72555,9 @@ paths:
description: Response
content:
application/json:
- schema: *505
+ schema: *502
examples:
- default: *507
+ default: *504
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72997,10 +72578,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *498
- - *331
- - *330
- - *508
+ - *495
+ - *328
+ - *327
+ - *505
responses:
'204':
description: Response
@@ -73026,9 +72607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *17
- *19
responses:
@@ -73046,9 +72627,9 @@ paths:
type: integer
secrets:
type: array
- items: *375
+ items: *372
examples:
- default: *376
+ default: *373
headers:
Link: *58
x-github:
@@ -73073,17 +72654,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
responses:
'200':
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73105,18 +72686,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *375
+ schema: *372
examples:
- default: *509
+ default: *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73138,9 +72719,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *159
requestBody:
required: true
@@ -73198,9 +72779,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *159
responses:
'204':
@@ -73226,10 +72807,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *330
- - *331
- - *498
- - *346
+ - *327
+ - *328
+ - *495
+ - *343
- *19
responses:
'200':
@@ -73246,9 +72827,9 @@ paths:
type: integer
variables:
type: array
- items: *379
+ items: *376
examples:
- default: *380
+ default: *377
headers:
Link: *58
x-github:
@@ -73271,9 +72852,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
requestBody:
required: true
content:
@@ -73325,18 +72906,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *379
+ schema: *376
examples:
- default: *510
+ default: *507
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73357,10 +72938,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
- - *498
+ - *495
requestBody:
required: true
content:
@@ -73402,10 +72983,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
- - *498
+ - *495
responses:
'204':
description: Response
@@ -73427,8 +73008,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -73496,8 +73077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -73656,8 +73237,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -73689,9 +73270,9 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
'400': *14
'422': *15
'403': *29
@@ -73712,8 +73293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -73773,7 +73354,7 @@ paths:
schema:
oneOf:
- *120
- - *511
+ - *508
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73798,8 +73379,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: file_sha
in: path
required: true
@@ -73898,8 +73479,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74008,7 +73589,7 @@ paths:
description: Response
content:
application/json:
- schema: &512
+ schema: &509
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -74222,15 +73803,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
responses:
'200':
description: Response
content:
application/json:
- schema: *512
+ schema: *509
examples:
default:
value:
@@ -74286,9 +73867,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *330
- - *331
- - &513
+ - *327
+ - *328
+ - &510
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.
@@ -74305,7 +73886,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &511
title: Git Reference
description: Git references within a repository
type: object
@@ -74380,17 +73961,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *330
- - *331
- - *513
+ - *327
+ - *328
+ - *510
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &515
+ default: &512
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -74419,8 +74000,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74449,9 +74030,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -74477,9 +74058,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *330
- - *331
- - *513
+ - *327
+ - *328
+ - *510
requestBody:
required: true
content:
@@ -74508,9 +74089,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
'422': *15
'409': *51
x-github:
@@ -74528,9 +74109,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *330
- - *331
- - *513
+ - *327
+ - *328
+ - *510
responses:
'204':
description: Response
@@ -74585,8 +74166,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74653,7 +74234,7 @@ paths:
description: Response
content:
application/json:
- schema: &517
+ schema: &514
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -74704,7 +74285,7 @@ paths:
- sha
- type
- url
- verification: *516
+ verification: *513
required:
- sha
- url
@@ -74714,7 +74295,7 @@ paths:
- tag
- message
examples:
- default: &518
+ default: &515
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -74787,8 +74368,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: tag_sha
in: path
required: true
@@ -74799,9 +74380,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'404': *6
'409': *51
x-github:
@@ -74825,8 +74406,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74899,7 +74480,7 @@ paths:
description: Response
content:
application/json:
- schema: &519
+ schema: &516
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -74995,8 +74576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -75019,7 +74600,7 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
default-response:
summary: Default response
@@ -75078,8 +74659,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -75089,7 +74670,7 @@ paths:
application/json:
schema:
type: array
- items: &520
+ items: &517
title: Webhook
description: Webhooks for repositories.
type: object
@@ -75143,7 +74724,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &764
+ last_response: &759
title: Hook Response
type: object
properties:
@@ -75217,8 +74798,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -75270,9 +74851,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: &521
+ default: &518
value:
type: Repository
id: 12345678
@@ -75320,17 +74901,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'200':
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *521
+ default: *518
'404': *6
x-github:
githubCloudOnly: false
@@ -75350,8 +74931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
requestBody:
required: true
@@ -75397,9 +74978,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *521
+ default: *518
'422': *15
'404': *6
x-github:
@@ -75420,8 +75001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'204':
@@ -75446,8 +75027,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'200':
@@ -75475,8 +75056,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
requestBody:
required: false
@@ -75521,8 +75102,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
- *17
- *205
@@ -75554,8 +75135,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
- *16
responses:
@@ -75584,8 +75165,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
- *16
responses:
@@ -75609,8 +75190,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'204':
@@ -75636,8 +75217,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'204':
@@ -75661,8 +75242,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response if immutable releases are enabled
@@ -75708,8 +75289,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-immutable-releases
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'409': *51
@@ -75729,8 +75310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-immutable-releases
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'409': *51
@@ -75787,14 +75368,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &522
+ schema: &519
title: Import
description: A repository import from an external source.
type: object
@@ -75893,7 +75474,7 @@ paths:
- html_url
- authors_url
examples:
- default: &525
+ default: &522
value:
vcs: subversion
use_lfs: true
@@ -75909,7 +75490,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': &523
+ '503': &520
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -75938,8 +75519,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -75987,7 +75568,7 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
default:
value:
@@ -76012,7 +75593,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76040,8 +75621,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -76090,7 +75671,7 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
example-1:
summary: Example 1
@@ -76138,7 +75719,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': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76161,12 +75742,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76192,9 +75773,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *330
- - *331
- - &697
+ - *327
+ - *328
+ - &692
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -76208,7 +75789,7 @@ paths:
application/json:
schema:
type: array
- items: &524
+ items: &521
title: Porter Author
description: Porter Author
type: object
@@ -76262,7 +75843,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': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76287,8 +75868,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: author_id
in: path
required: true
@@ -76318,7 +75899,7 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *521
examples:
default:
value:
@@ -76331,7 +75912,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76355,8 +75936,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -76397,7 +75978,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76425,8 +76006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -76453,11 +76034,11 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
- default: *525
+ default: *522
'422': *15
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76480,8 +76061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -76489,8 +76070,8 @@ paths:
application/json:
schema: *22
examples:
- default: *526
- '301': *334
+ default: *523
+ '301': *331
'404': *6
x-github:
githubCloudOnly: false
@@ -76510,8 +76091,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -76524,7 +76105,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &528
+ default: &525
value:
limit: collaborators_only
origin: repository
@@ -76549,13 +76130,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *527
+ schema: *524
examples:
default:
summary: Example request body
@@ -76569,7 +76150,7 @@ paths:
application/json:
schema: *222
examples:
- default: *528
+ default: *525
'409':
description: Response
x-github:
@@ -76591,8 +76172,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -76615,8 +76196,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -76626,9 +76207,9 @@ paths:
application/json:
schema:
type: array
- items: *529
+ items: *526
examples:
- default: &690
+ default: &685
value:
- id: 1
repository:
@@ -76759,8 +76340,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *226
requestBody:
required: false
@@ -76790,7 +76371,7 @@ paths:
description: Response
content:
application/json:
- schema: *529
+ schema: *526
examples:
default:
value:
@@ -76921,8 +76502,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *226
responses:
'204':
@@ -76954,8 +76535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -77028,7 +76609,7 @@ paths:
type: array
items: *74
examples:
- default: &541
+ default: &538
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -77176,7 +76757,7 @@ paths:
state_reason: completed
headers:
Link: *58
- '301': *334
+ '301': *331
'422': *15
'404': *6
x-github:
@@ -77205,8 +76786,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -77290,7 +76871,7 @@ paths:
application/json:
schema: *74
examples:
- default: &538
+ default: &535
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -77446,7 +77027,7 @@ paths:
'422': *15
'503': *112
'404': *6
- '410': *530
+ '410': *527
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -77474,8 +77055,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *98
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -77496,9 +77077,9 @@ paths:
application/json:
schema:
type: array
- items: *531
+ items: *528
examples:
- default: &540
+ default: &537
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77556,17 +77137,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'200':
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: &532
+ default: &529
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77620,8 +77201,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -77644,9 +77225,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
'422': *15
x-github:
githubCloudOnly: false
@@ -77664,8 +77245,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'204':
@@ -77686,8 +77267,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -77714,9 +77295,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
@@ -77737,8 +77318,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -77771,16 +77352,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -77802,10 +77383,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- - *534
+ - *531
responses:
'204':
description: Response
@@ -77825,8 +77406,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -77836,7 +77417,7 @@ paths:
application/json:
schema:
type: array
- items: &537
+ items: &534
title: Issue Event
description: Issue Event
type: object
@@ -77879,8 +77460,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *535
- required: *536
+ properties: *532
+ required: *533
nullable: true
label:
title: Issue Event Label
@@ -78187,8 +77768,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: event_id
in: path
required: true
@@ -78199,7 +77780,7 @@ paths:
description: Response
content:
application/json:
- schema: *537
+ schema: *534
examples:
default:
value:
@@ -78391,7 +77972,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *530
+ '410': *527
'403': *29
x-github:
githubCloudOnly: false
@@ -78425,9 +78006,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *330
- - *331
- - &539
+ - *327
+ - *328
+ - &536
name: issue_number
description: The number that identifies the issue.
in: path
@@ -78441,10 +78022,10 @@ paths:
application/json:
schema: *74
examples:
- default: *538
- '301': *334
+ default: *535
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
'304': *37
x-github:
githubCloudOnly: false
@@ -78469,9 +78050,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -78577,13 +78158,13 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
'422': *15
'503': *112
'403': *29
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78601,9 +78182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -78631,7 +78212,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78647,9 +78228,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
content:
application/json:
@@ -78676,7 +78257,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78698,9 +78279,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:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- name: assignee
in: path
required: true
@@ -78740,9 +78321,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *81
- *17
- *19
@@ -78753,13 +78334,13 @@ paths:
application/json:
schema:
type: array
- items: *531
+ items: *528
examples:
- default: *540
+ default: *537
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78788,9 +78369,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -78812,16 +78393,16 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *530
+ '410': *527
'422': *15
'404': *6
x-github:
@@ -78849,9 +78430,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -78863,12 +78444,12 @@ paths:
type: array
items: *74
examples:
- default: *541
+ default: *538
headers:
Link: *58
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78896,9 +78477,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -78922,15 +78503,15 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *334
+ '301': *331
'403': *29
- '410': *530
+ '410': *527
'422': *15
'404': *6
x-github:
@@ -78961,9 +78542,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -78977,13 +78558,13 @@ paths:
application/json:
schema: *74
examples:
- default: *538
- '301': *334
+ default: *535
+ '301': *331
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *530
+ '410': *527
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -79009,9 +78590,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -79023,12 +78604,12 @@ paths:
type: array
items: *74
examples:
- default: *541
+ default: *538
headers:
Link: *58
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79045,9 +78626,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -79061,7 +78642,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &543
+ - &540
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -79115,7 +78696,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &544
+ - &541
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -79251,7 +78832,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &545
+ - &542
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -79302,7 +78883,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &546
+ - &543
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -79353,7 +78934,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &547
+ - &544
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -79407,7 +78988,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &548
+ - &545
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -79454,7 +79035,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &549
+ - &546
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -79501,7 +79082,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &550
+ - &547
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -79561,7 +79142,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &551
+ - &548
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -79609,7 +79190,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &552
+ - &549
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -79675,7 +79256,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &553
+ - &550
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -79741,7 +79322,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &554
+ - &551
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -79807,7 +79388,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &555
+ - &552
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -79898,7 +79479,7 @@ paths:
color: red
headers:
Link: *58
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79915,9 +79496,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -79929,7 +79510,7 @@ paths:
type: array
items: *73
examples:
- default: &542
+ default: &539
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -79947,9 +79528,9 @@ paths:
default: false
headers:
Link: *58
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79966,9 +79547,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -80029,10 +79610,10 @@ paths:
type: array
items: *73
examples:
- default: *542
- '301': *334
+ default: *539
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
'422': *15
x-github:
githubCloudOnly: false
@@ -80049,9 +79630,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -80113,10 +79694,10 @@ paths:
type: array
items: *73
examples:
- default: *542
- '301': *334
+ default: *539
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
'422': *15
x-github:
githubCloudOnly: false
@@ -80133,15 +79714,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
responses:
'204':
description: Response
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80160,9 +79741,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- name: name
in: path
required: true
@@ -80186,9 +79767,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80208,9 +79789,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -80238,7 +79819,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *530
+ '410': *527
'404': *6
'422': *15
x-github:
@@ -80256,9 +79837,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
responses:
'204':
description: Response
@@ -80288,9 +79869,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
responses:
'200':
description: Response
@@ -80298,10 +79879,10 @@ paths:
application/json:
schema: *74
examples:
- default: *538
- '301': *334
+ default: *535
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80318,9 +79899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- 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.
@@ -80346,13 +79927,13 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80370,9 +79951,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80404,16 +79985,16 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -80435,10 +80016,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *330
- - *331
- - *539
- - *534
+ - *327
+ - *328
+ - *536
+ - *531
responses:
'204':
description: Response
@@ -80467,9 +80048,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80493,7 +80074,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -80526,9 +80107,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -80540,11 +80121,11 @@ paths:
type: array
items: *74
examples:
- default: *541
+ default: *538
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80572,9 +80153,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80603,14 +80184,14 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *530
+ '410': *527
'422': *15
'404': *6
x-github:
@@ -80630,9 +80211,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80665,7 +80246,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
'403': *29
'404': *6
'422': *7
@@ -80687,9 +80268,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -80704,6 +80285,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *540
+ - *541
+ - *542
- *543
- *544
- *545
@@ -80714,9 +80298,6 @@ paths:
- *550
- *551
- *552
- - *553
- - *554
- - *555
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -81025,7 +80606,7 @@ paths:
type: string
comments:
type: array
- items: &577
+ items: &574
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -81234,7 +80815,7 @@ paths:
type: string
comments:
type: array
- items: *461
+ items: *458
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -81523,7 +81104,7 @@ paths:
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81540,8 +81121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -81551,7 +81132,7 @@ paths:
application/json:
schema:
type: array
- items: &556
+ items: &553
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -81617,8 +81198,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -81654,9 +81235,9 @@ paths:
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: &557
+ default: &554
value:
id: 1
key: ssh-rsa AAA...
@@ -81690,9 +81271,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *330
- - *331
- - &558
+ - *327
+ - *328
+ - &555
name: key_id
description: The unique identifier of the key.
in: path
@@ -81704,9 +81285,9 @@ paths:
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'404': *6
x-github:
githubCloudOnly: false
@@ -81724,9 +81305,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *330
- - *331
- - *558
+ - *327
+ - *328
+ - *555
responses:
'204':
description: Response
@@ -81746,8 +81327,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -81759,7 +81340,7 @@ paths:
type: array
items: *73
examples:
- default: *542
+ default: *539
headers:
Link: *58
'404': *6
@@ -81780,8 +81361,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -81819,7 +81400,7 @@ paths:
application/json:
schema: *73
examples:
- default: &559
+ default: &556
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -81851,8 +81432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: name
in: path
required: true
@@ -81865,7 +81446,7 @@ paths:
application/json:
schema: *73
examples:
- default: *559
+ default: *556
'404': *6
x-github:
githubCloudOnly: false
@@ -81882,8 +81463,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: name
in: path
required: true
@@ -81948,8 +81529,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: name
in: path
required: true
@@ -81975,8 +81556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -82015,9 +81596,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *330
- - *331
- - *434
+ - *327
+ - *328
+ - *431
responses:
'200':
description: Response
@@ -82162,8 +81743,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82228,8 +81809,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82263,9 +81844,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *560
+ default: *557
'204':
description: Response when already merged
'404':
@@ -82290,8 +81871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -82332,7 +81913,7 @@ paths:
application/json:
schema:
type: array
- items: &561
+ items: &558
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -82393,8 +81974,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82434,9 +82015,9 @@ paths:
description: Response
content:
application/json:
- schema: *561
+ schema: *558
examples:
- default: &562
+ default: &559
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -82495,9 +82076,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *330
- - *331
- - &563
+ - *327
+ - *328
+ - &560
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -82509,9 +82090,9 @@ paths:
description: Response
content:
application/json:
- schema: *561
+ schema: *558
examples:
- default: *562
+ default: *559
'404': *6
x-github:
githubCloudOnly: false
@@ -82528,9 +82109,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *330
- - *331
- - *563
+ - *327
+ - *328
+ - *560
requestBody:
required: false
content:
@@ -82568,9 +82149,9 @@ paths:
description: Response
content:
application/json:
- schema: *561
+ schema: *558
examples:
- default: *562
+ default: *559
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82586,9 +82167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *330
- - *331
- - *563
+ - *327
+ - *328
+ - *560
responses:
'204':
description: Response
@@ -82609,9 +82190,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *330
- - *331
- - *563
+ - *327
+ - *328
+ - *560
- *17
- *19
responses:
@@ -82623,7 +82204,7 @@ paths:
type: array
items: *73
examples:
- default: *542
+ default: *539
headers:
Link: *58
x-github:
@@ -82642,12 +82223,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *330
- - *331
- - *564
- - *565
+ - *327
+ - *328
+ - *561
+ - *562
- *81
- - *566
+ - *563
- *17
- *19
responses:
@@ -82659,7 +82240,7 @@ paths:
type: array
items: *101
examples:
- default: *567
+ default: *564
headers:
Link: *58
x-github:
@@ -82683,8 +82264,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -82742,14 +82323,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &568
+ schema: &565
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -82874,7 +82455,7 @@ paths:
- custom_404
- public
examples:
- default: &569
+ default: &566
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -82915,8 +82496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82970,9 +82551,9 @@ paths:
description: Response
content:
application/json:
- schema: *568
+ schema: *565
examples:
- default: *569
+ default: *566
'422': *15
'409': *51
x-github:
@@ -82995,8 +82576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -83095,8 +82676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -83122,8 +82703,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -83133,7 +82714,7 @@ paths:
application/json:
schema:
type: array
- items: &570
+ items: &567
title: Page Build
description: Page Build
type: object
@@ -83227,8 +82808,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'201':
description: Response
@@ -83273,16 +82854,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *570
+ schema: *567
examples:
- default: &571
+ default: &568
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -83330,8 +82911,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: build_id
in: path
required: true
@@ -83342,9 +82923,9 @@ paths:
description: Response
content:
application/json:
- schema: *570
+ schema: *567
examples:
- default: *571
+ default: *568
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -83364,8 +82945,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -83470,9 +83051,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *330
- - *331
- - &572
+ - *327
+ - *328
+ - &569
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -83530,9 +83111,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *330
- - *331
- - *572
+ - *327
+ - *328
+ - *569
responses:
'204': *183
'404': *6
@@ -83559,8 +83140,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -83818,8 +83399,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Private vulnerability reporting status
@@ -83856,8 +83437,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'422': *14
@@ -83878,8 +83459,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'422': *14
@@ -83901,8 +83482,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -83912,7 +83493,7 @@ paths:
type: array
items: *110
examples:
- default: *573
+ default: *570
'403': *29
'404': *6
x-github:
@@ -83934,8 +83515,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -83951,7 +83532,7 @@ paths:
required:
- properties
examples:
- default: *574
+ default: *571
responses:
'204':
description: No Content when custom property values are successfully created
@@ -83989,8 +83570,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -84050,9 +83631,9 @@ paths:
application/json:
schema:
type: array
- items: *468
+ items: *465
examples:
- default: *575
+ default: *572
headers:
Link: *58
'304': *37
@@ -84084,8 +83665,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -84150,7 +83731,7 @@ paths:
description: Response
content:
application/json:
- schema: &579
+ schema: &576
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -84364,7 +83945,7 @@ paths:
- review_comment
- self
author_association: *75
- auto_merge: *576
+ auto_merge: *573
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -84456,7 +84037,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &580
+ default: &577
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -84983,8 +84564,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sort
in: query
required: false
@@ -85013,9 +84594,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: &582
+ default: &579
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -85092,17 +84673,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'200':
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: &578
+ default: &575
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -85177,8 +84758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -85201,9 +84782,9 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85219,8 +84800,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'204':
@@ -85242,8 +84823,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -85270,9 +84851,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
@@ -85293,8 +84874,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -85327,16 +84908,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -85358,10 +84939,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- - *534
+ - *531
responses:
'204':
description: Response
@@ -85404,9 +84985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *330
- - *331
- - &581
+ - *327
+ - *328
+ - &578
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -85419,9 +85000,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
'304': *37
'404': *6
'406':
@@ -85456,9 +85037,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -85500,9 +85081,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
'422': *15
'403': *29
x-github:
@@ -85524,9 +85105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: true
content:
@@ -85588,7 +85169,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -85596,7 +85177,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'401': *25
'403': *29
'404': *6
@@ -85626,9 +85207,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *98
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -85649,9 +85230,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *582
+ default: *579
headers:
Link: *58
x-github:
@@ -85684,9 +85265,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: true
content:
@@ -85791,7 +85372,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
example-for-a-multi-line-comment:
value:
@@ -85879,9 +85460,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *90
requestBody:
required: true
@@ -85904,7 +85485,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
default:
value:
@@ -85990,9 +85571,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *17
- *19
responses:
@@ -86002,9 +85583,9 @@ paths:
application/json:
schema:
type: array
- items: *464
+ items: *461
examples:
- default: *583
+ default: *580
headers:
Link: *58
x-github:
@@ -86034,9 +85615,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *17
- *19
responses:
@@ -86046,7 +85627,7 @@ paths:
application/json:
schema:
type: array
- items: *477
+ items: *474
examples:
default:
value:
@@ -86084,9 +85665,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
responses:
'204':
description: Response if pull request has been merged
@@ -86109,9 +85690,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -86222,9 +85803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
responses:
'200':
description: Response
@@ -86299,9 +85880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -86338,7 +85919,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -86874,9 +86455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: true
content:
@@ -86910,7 +86491,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -87415,9 +86996,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *17
- *19
responses:
@@ -87427,7 +87008,7 @@ paths:
application/json:
schema:
type: array
- items: &584
+ items: &581
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -87578,9 +87159,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -87666,9 +87247,9 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: &586
+ default: &583
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87731,10 +87312,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - &585
+ - *327
+ - *328
+ - *578
+ - &582
name: review_id
description: The unique identifier of the review.
in: path
@@ -87746,9 +87327,9 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: &587
+ default: &584
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87807,10 +87388,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
requestBody:
required: true
content:
@@ -87833,7 +87414,7 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
default:
value:
@@ -87895,18 +87476,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
responses:
'200':
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: *586
+ default: *583
'422': *7
'404': *6
x-github:
@@ -87933,10 +87514,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
- *17
- *19
responses:
@@ -88171,10 +87752,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
requestBody:
required: true
content:
@@ -88202,7 +87783,7 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
default:
value:
@@ -88265,10 +87846,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
requestBody:
required: true
content:
@@ -88303,9 +87884,9 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: *587
+ default: *584
'404': *6
'422': *7
'403': *29
@@ -88327,9 +87908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -88392,8 +87973,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -88406,9 +87987,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: &589
+ default: &586
value:
type: file
encoding: base64
@@ -88450,8 +88031,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: dir
description: The alternate path to look for a README file
in: path
@@ -88471,9 +88052,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: *589
+ default: *586
'404': *6
'422': *15
x-github:
@@ -88495,8 +88076,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -88506,7 +88087,7 @@ paths:
application/json:
schema:
type: array
- items: *590
+ items: *587
examples:
default:
value:
@@ -88600,8 +88181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -88677,9 +88258,9 @@ paths:
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: &594
+ default: &591
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -88784,9 +88365,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *330
- - *331
- - &592
+ - *327
+ - *328
+ - &589
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -88798,9 +88379,9 @@ paths:
description: Response
content:
application/json:
- schema: *591
+ schema: *588
examples:
- default: &593
+ default: &590
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
@@ -88835,7 +88416,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *479
+ '302': *476
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88851,9 +88432,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *330
- - *331
- - *592
+ - *327
+ - *328
+ - *589
requestBody:
required: false
content:
@@ -88881,9 +88462,9 @@ paths:
description: Response
content:
application/json:
- schema: *591
+ schema: *588
examples:
- default: *593
+ default: *590
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88899,9 +88480,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *330
- - *331
- - *592
+ - *327
+ - *328
+ - *589
responses:
'204':
description: Response
@@ -88925,8 +88506,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -89011,16 +88592,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: *594
+ default: *591
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89037,8 +88618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: tag
description: tag parameter
in: path
@@ -89051,9 +88632,9 @@ paths:
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: *594
+ default: *591
'404': *6
x-github:
githubCloudOnly: false
@@ -89075,9 +88656,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *330
- - *331
- - &595
+ - *327
+ - *328
+ - &592
name: release_id
description: The unique identifier of the release.
in: path
@@ -89091,9 +88672,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: *590
+ schema: *587
examples:
- default: *594
+ default: *591
'401':
description: Unauthorized
x-github:
@@ -89111,9 +88692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
requestBody:
required: false
content:
@@ -89177,9 +88758,9 @@ paths:
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: *594
+ default: *591
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -89200,9 +88781,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
responses:
'204':
description: Response
@@ -89222,9 +88803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
- *17
- *19
responses:
@@ -89234,7 +88815,7 @@ paths:
application/json:
schema:
type: array
- items: *591
+ items: *588
examples:
default:
value:
@@ -89315,9 +88896,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:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
- name: name
in: query
required: true
@@ -89343,7 +88924,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *591
+ schema: *588
examples:
response-for-successful-upload:
value:
@@ -89398,9 +88979,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
- 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.
@@ -89424,9 +89005,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
@@ -89447,9 +89028,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
requestBody:
required: true
content:
@@ -89479,16 +89060,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -89510,10 +89091,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *330
- - *331
- - *595
- - *534
+ - *327
+ - *328
+ - *592
+ - *531
responses:
'204':
description: Response
@@ -89537,9 +89118,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
- *17
- *19
responses:
@@ -89556,7 +89137,7 @@ paths:
oneOf:
- allOf:
- *286
- - &596
+ - &593
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -89577,67 +89158,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *287
- - *596
+ - *593
- allOf:
- *288
- - *596
+ - *593
- allOf:
- *289
- - *596
+ - *593
- allOf:
- - *597
- - *596
+ - *594
+ - *593
- allOf:
- *290
- - *596
+ - *593
- allOf:
- *291
- - *596
+ - *593
- allOf:
- *292
- - *596
+ - *593
- allOf:
- *293
- - *596
+ - *593
- allOf:
- *294
- - *596
+ - *593
- allOf:
- *295
- - *596
+ - *593
- allOf:
- *296
- - *596
+ - *593
- allOf:
- *297
- - *596
+ - *593
- allOf:
- *298
- - *596
+ - *593
- allOf:
- *299
- - *596
+ - *593
- allOf:
- *300
- - *596
+ - *593
- allOf:
- *301
- - *596
+ - *593
- allOf:
- *302
- - *596
+ - *593
- allOf:
- *303
- - *596
+ - *593
- allOf:
- *304
- - *596
+ - *593
- allOf:
- *305
- - *596
+ - *593
- allOf:
- *306
- - *596
+ - *593
examples:
default:
value:
@@ -89676,8 +89257,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- name: includes_parents
@@ -89688,7 +89269,7 @@ paths:
schema:
type: boolean
default: true
- - *598
+ - *595
responses:
'200':
description: Response
@@ -89743,8 +89324,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
description: Request body
required: true
@@ -89773,7 +89354,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *599
+ items: *596
required:
- name
- enforcement
@@ -89806,7 +89387,7 @@ paths:
application/json:
schema: *307
examples:
- default: &609
+ default: &606
value:
id: 42
name: super cool ruleset
@@ -89853,12 +89434,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *330
- - *331
+ - *327
+ - *328
+ - *597
+ - *598
+ - *599
- *600
- - *601
- - *602
- - *603
- *17
- *19
responses:
@@ -89866,9 +89447,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
'404': *6
'500': *111
x-github:
@@ -89889,17 +89470,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *330
- - *331
- - *606
+ - *327
+ - *328
+ - *603
responses:
'200':
description: Response
content:
application/json:
- schema: *607
+ schema: *604
examples:
- default: *608
+ default: *605
'404': *6
'500': *111
x-github:
@@ -89927,8 +89508,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89950,7 +89531,7 @@ paths:
application/json:
schema: *307
examples:
- default: *609
+ default: *606
'404': *6
'500': *111
put:
@@ -89968,8 +89549,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -90003,7 +89584,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *599
+ items: *596
examples:
default:
value:
@@ -90033,7 +89614,7 @@ paths:
application/json:
schema: *307
examples:
- default: *609
+ default: *606
'404': *6
'500': *111
delete:
@@ -90051,8 +89632,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -90075,8 +89656,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- name: ruleset_id
@@ -90094,7 +89675,7 @@ paths:
type: array
items: *310
examples:
- default: *610
+ default: *607
'404': *6
'500': *111
x-github:
@@ -90113,8 +89694,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -90132,7 +89713,7 @@ paths:
description: Response
content:
application/json:
- schema: *611
+ schema: *608
examples:
default:
value:
@@ -90187,22 +89768,22 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
+ - *609
+ - *610
+ - *611
- *612
- *613
- - *614
- - *615
- - *616
- *52
- *19
- *17
+ - *614
+ - *615
+ - *616
- *617
- *618
- *619
- - *620
- - *621
- - *622
responses:
'200':
description: Response
@@ -90210,7 +89791,7 @@ paths:
application/json:
schema:
type: array
- items: &626
+ items: &623
type: object
properties:
number: *169
@@ -90229,8 +89810,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *623
- resolution: *624
+ state: *620
+ resolution: *621
resolved_at:
type: string
format: date-time
@@ -90326,7 +89907,7 @@ paths:
pull request.
'
- oneOf: *625
+ oneOf: *622
nullable: true
has_more_locations:
type: boolean
@@ -90475,16 +90056,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *330
- - *331
- - *428
- - *622
+ - *327
+ - *328
+ - *425
+ - *619
responses:
'200':
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -90538,9 +90119,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
requestBody:
required: true
content:
@@ -90548,8 +90129,8 @@ paths:
schema:
type: object
properties:
- state: *623
- resolution: *624
+ state: *620
+ resolution: *621
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -90583,7 +90164,7 @@ paths:
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -90678,9 +90259,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
- *19
- *17
responses:
@@ -90691,7 +90272,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &786
+ items: &781
type: object
properties:
type:
@@ -90717,6 +90298,9 @@ paths:
example: commit
details:
oneOf:
+ - *624
+ - *625
+ - *626
- *627
- *628
- *629
@@ -90727,9 +90311,6 @@ paths:
- *634
- *635
- *636
- - *637
- - *638
- - *639
examples:
default:
value:
@@ -90815,8 +90396,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -90824,14 +90405,14 @@ paths:
schema:
type: object
properties:
- reason: &641
+ reason: &638
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *640
+ placeholder_id: *637
required:
- reason
- placeholder_id
@@ -90848,7 +90429,7 @@ paths:
schema:
type: object
properties:
- reason: *641
+ reason: *638
expire_at:
type: string
format: date-time
@@ -90894,8 +90475,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -90910,7 +90491,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &642
+ items: &639
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -90936,15 +90517,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *642
+ items: *639
backfill_scans:
type: array
- items: *642
+ items: *639
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *642
+ - *639
- type: object
properties:
pattern_name:
@@ -91014,8 +90595,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *52
- name: sort
description: The property to sort the results by.
@@ -91059,9 +90640,9 @@ paths:
application/json:
schema:
type: array
- items: *643
+ items: *640
examples:
- default: *644
+ default: *641
'400': *14
'404': *6
x-github:
@@ -91084,8 +90665,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -91245,9 +90826,9 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
- default: &646
+ default: &643
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -91480,8 +91061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -91585,7 +91166,7 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
default:
value:
@@ -91732,17 +91313,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
responses:
'200':
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
- default: *646
+ default: *643
'403': *29
'404': *6
x-github:
@@ -91766,9 +91347,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
requestBody:
required: true
content:
@@ -91927,10 +91508,10 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
- default: *646
- add_credit: *646
+ default: *643
+ add_credit: *643
'403': *29
'404': *6
'422':
@@ -91968,9 +91549,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:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
responses:
'202': *39
'400': *14
@@ -91997,17 +91578,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
responses:
'202':
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
'400': *14
'422': *15
'403': *29
@@ -92033,8 +91614,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -92133,8 +91714,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -92143,7 +91724,7 @@ paths:
application/json:
schema:
type: array
- items: &647
+ items: &644
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -92176,8 +91757,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -92253,8 +91834,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -92350,8 +91931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -92505,8 +92086,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -92516,7 +92097,7 @@ paths:
application/json:
schema:
type: array
- items: *647
+ items: *644
examples:
default:
value:
@@ -92549,8 +92130,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sha
in: path
required: true
@@ -92604,7 +92185,7 @@ paths:
description: Response
content:
application/json:
- schema: *648
+ schema: *645
examples:
default:
value:
@@ -92658,8 +92239,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -92691,14 +92272,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &649
+ schema: &646
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -92766,8 +92347,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -92793,7 +92374,7 @@ paths:
description: Response
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
value:
@@ -92820,8 +92401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -92841,8 +92422,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -92921,8 +92502,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -92930,7 +92511,7 @@ paths:
application/json:
schema:
type: array
- items: &650
+ items: &647
title: Tag protection
description: Tag protection
type: object
@@ -92982,8 +92563,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -93006,7 +92587,7 @@ paths:
description: Response
content:
application/json:
- schema: *650
+ schema: *647
examples:
default:
value:
@@ -93037,8 +92618,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:
- - *330
- - *331
+ - *327
+ - *328
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -93075,8 +92656,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
in: path
required: true
@@ -93112,8 +92693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -93145,8 +92726,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *19
- *17
responses:
@@ -93154,7 +92735,7 @@ paths:
description: Response
content:
application/json:
- schema: &651
+ schema: &648
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -93166,7 +92747,7 @@ paths:
required:
- names
examples:
- default: &652
+ default: &649
value:
names:
- octocat
@@ -93189,8 +92770,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -93221,9 +92802,9 @@ paths:
description: Response
content:
application/json:
- schema: *651
+ schema: *648
examples:
- default: *652
+ default: *649
'404': *6
'422': *7
x-github:
@@ -93244,9 +92825,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *330
- - *331
- - &653
+ - *327
+ - *328
+ - &650
name: per
description: The time frame to display results for.
in: query
@@ -93275,7 +92856,7 @@ paths:
example: 128
clones:
type: array
- items: &654
+ items: &651
title: Traffic
type: object
properties:
@@ -93363,8 +92944,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -93455,8 +93036,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -93517,9 +93098,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *330
- - *331
- - *653
+ - *327
+ - *328
+ - *650
responses:
'200':
description: Response
@@ -93538,7 +93119,7 @@ paths:
example: 3782
views:
type: array
- items: *654
+ items: *651
required:
- uniques
- count
@@ -93616,8 +93197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -93891,8 +93472,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -93915,8 +93496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -93938,8 +93519,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -93965,8 +93546,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
in: path
required: true
@@ -94058,9 +93639,9 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -94308,7 +93889,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &655
+ text_matches: &652
title: Search Result Text Matches
type: array
items:
@@ -94470,7 +94051,7 @@ paths:
enum:
- author-date
- committer-date
- - &656
+ - &653
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
@@ -94541,7 +94122,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *395
+ properties: *392
nullable: true
comment_count:
type: integer
@@ -94561,7 +94142,7 @@ paths:
url:
type: string
format: uri
- verification: *516
+ verification: *513
required:
- author
- committer
@@ -94580,7 +94161,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *395
+ properties: *392
nullable: true
parents:
type: array
@@ -94598,7 +94179,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *655
+ text_matches: *652
required:
- sha
- node_id
@@ -94790,7 +94371,7 @@ paths:
- interactions
- created
- updated
- - *656
+ - *653
- *17
- *19
- name: advanced_search
@@ -94887,11 +94468,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
type: string
state_reason:
@@ -94923,7 +94504,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *655
+ text_matches: *652
pull_request:
type: object
properties:
@@ -95148,7 +94729,7 @@ paths:
enum:
- created
- updated
- - *656
+ - *653
- *17
- *19
responses:
@@ -95192,7 +94773,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *655
+ text_matches: *652
required:
- id
- node_id
@@ -95277,7 +94858,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *656
+ - *653
- *17
- *19
responses:
@@ -95516,7 +95097,7 @@ paths:
- admin
- pull
- push
- text_matches: *655
+ text_matches: *652
temp_clone_token:
type: string
allow_merge_commit:
@@ -95816,7 +95397,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *655
+ text_matches: *652
related:
type: array
nullable: true
@@ -96007,7 +95588,7 @@ paths:
- followers
- repositories
- joined
- - *656
+ - *653
- *17
- *19
responses:
@@ -96111,7 +95692,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *655
+ text_matches: *652
blog:
type: string
nullable: true
@@ -96190,7 +95771,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &660
+ - &657
name: team_id
description: The unique identifier of the team.
in: path
@@ -96231,7 +95812,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *660
+ - *657
requestBody:
required: true
content:
@@ -96331,7 +95912,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *660
+ - *657
responses:
'204':
description: Response
@@ -96362,7 +95943,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
parameters:
- - *660
+ - *657
- *52
- *17
- *19
@@ -96375,7 +95956,7 @@ paths:
type: array
items: *323
examples:
- default: *661
+ default: *658
headers:
Link: *58
x-github:
@@ -96404,7 +95985,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *660
+ - *657
requestBody:
required: true
content:
@@ -96467,7 +96048,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *660
+ - *657
- *325
responses:
'200':
@@ -96501,7 +96082,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *660
+ - *657
- *325
requestBody:
required: false
@@ -96527,7 +96108,7 @@ paths:
application/json:
schema: *323
examples:
- default: *662
+ default: *659
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96552,7 +96133,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *660
+ - *657
- *325
responses:
'204':
@@ -96565,218 +96146,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - *660
- - *325
- - *52
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *326
- examples:
- default: *663
- headers:
- Link: *58
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *327
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- - *328
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *327
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- - *328
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *664
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- - *328
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -96792,7 +96161,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *660
+ - *657
- *17
- *19
responses:
@@ -96830,7 +96199,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *660
+ - *657
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -96881,7 +96250,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -96918,7 +96287,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -96958,7 +96327,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -96995,16 +96364,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'200':
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- response-if-user-is-a-team-maintainer: *665
+ response-if-user-is-a-team-maintainer: *660
'404': *6
x-github:
githubCloudOnly: false
@@ -97037,7 +96406,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *660
+ - *657
- *63
requestBody:
required: false
@@ -97063,9 +96432,9 @@ paths:
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- response-if-users-membership-with-team-is-now-pending: *666
+ response-if-users-membership-with-team-is-now-pending: *661
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -97099,7 +96468,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -97127,7 +96496,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *660
+ - *657
- *17
- *19
responses:
@@ -97169,15 +96538,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *660
- - *330
- - *331
+ - *657
+ - *327
+ - *328
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *667
+ schema: *662
examples:
alternative-response-with-extra-repository-information:
value:
@@ -97328,9 +96697,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *660
- - *330
- - *331
+ - *657
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -97380,9 +96749,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *660
- - *330
- - *331
+ - *657
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -97407,7 +96776,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *660
+ - *657
- *17
- *19
responses:
@@ -97419,7 +96788,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: *668
+ response-if-child-teams-exist: *663
headers:
Link: *58
'404': *6
@@ -97452,7 +96821,7 @@ paths:
application/json:
schema:
oneOf:
- - &670
+ - &665
title: Private User
description: Private User
type: object
@@ -97655,7 +97024,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *669
+ - *664
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -97808,7 +97177,7 @@ paths:
description: Response
content:
application/json:
- schema: *670
+ schema: *665
examples:
default:
value:
@@ -98154,7 +97523,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -98162,7 +97531,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'401': *25
'403': *29
'404': *6
@@ -98206,7 +97575,7 @@ paths:
type: integer
secrets:
type: array
- items: &671
+ items: &666
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -98246,7 +97615,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *454
+ default: *451
headers:
Link: *58
x-github:
@@ -98322,7 +97691,7 @@ paths:
description: Response
content:
application/json:
- schema: *671
+ schema: *666
examples:
default:
value:
@@ -98468,7 +97837,7 @@ paths:
type: array
items: *151
examples:
- default: *672
+ default: *667
'401': *25
'403': *29
'404': *6
@@ -98620,7 +97989,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'304': *37
'500': *111
'401': *25
@@ -98678,7 +98047,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'401': *25
'403': *29
'404': *6
@@ -98735,7 +98104,7 @@ paths:
description: Response
content:
application/json:
- schema: &673
+ schema: &668
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -98776,7 +98145,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &674
+ default: &669
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -98821,9 +98190,9 @@ paths:
description: Response
content:
application/json:
- schema: *673
+ schema: *668
examples:
- default: *674
+ default: *669
'404': *6
x-github:
githubCloudOnly: false
@@ -98860,9 +98229,9 @@ paths:
type: integer
machines:
type: array
- items: *675
+ items: *670
examples:
- default: *676
+ default: *671
'304': *37
'500': *111
'401': *25
@@ -98941,13 +98310,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *333
+ repository: *330
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *452
- required: *453
+ properties: *449
+ required: *450
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -99729,7 +99098,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'304': *37
'500': *111
'400': *14
@@ -99769,7 +99138,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'500': *111
'401': *25
'403': *29
@@ -99801,7 +99170,7 @@ paths:
type: array
items: *245
examples:
- default: &687
+ default: &682
value:
- id: 197
name: hello_docker
@@ -99902,7 +99271,7 @@ paths:
application/json:
schema:
type: array
- items: &677
+ items: &672
title: Email
description: Email
type: object
@@ -99967,9 +99336,9 @@ paths:
application/json:
schema:
type: array
- items: *677
+ items: *672
examples:
- default: &689
+ default: &684
value:
- email: octocat@github.com
verified: true
@@ -100044,7 +99413,7 @@ paths:
application/json:
schema:
type: array
- items: *677
+ items: *672
examples:
default:
value:
@@ -100300,7 +99669,7 @@ paths:
application/json:
schema:
type: array
- items: &678
+ items: &673
title: GPG Key
description: A unique encryption key
type: object
@@ -100431,7 +99800,7 @@ paths:
- subkeys
- revoked
examples:
- default: &703
+ default: &698
value:
- id: 3
name: Octocat's GPG Key
@@ -100516,9 +99885,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *673
examples:
- default: &679
+ default: &674
value:
id: 3
name: Octocat's GPG Key
@@ -100575,7 +99944,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &680
+ - &675
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -100587,9 +99956,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *673
examples:
- default: *679
+ default: *674
'404': *6
'304': *37
'403': *29
@@ -100612,7 +99981,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *680
+ - *675
responses:
'204':
description: Response
@@ -100917,7 +100286,7 @@ paths:
required: true
content:
application/json:
- schema: *527
+ schema: *524
examples:
default:
value:
@@ -101067,7 +100436,7 @@ paths:
application/json:
schema:
type: array
- items: &681
+ items: &676
title: Key
description: Key
type: object
@@ -101168,9 +100537,9 @@ paths:
description: Response
content:
application/json:
- schema: *681
+ schema: *676
examples:
- default: &682
+ default: &677
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -101203,15 +100572,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *558
+ - *555
responses:
'200':
description: Response
content:
application/json:
- schema: *681
+ schema: *676
examples:
- default: *682
+ default: *677
'404': *6
'304': *37
'403': *29
@@ -101234,7 +100603,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *558
+ - *555
responses:
'204':
description: Response
@@ -101267,7 +100636,7 @@ paths:
application/json:
schema:
type: array
- items: &683
+ items: &678
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -101335,7 +100704,7 @@ paths:
- account
- plan
examples:
- default: &684
+ default: &679
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -101397,9 +100766,9 @@ paths:
application/json:
schema:
type: array
- items: *683
+ items: *678
examples:
- default: *684
+ default: *679
headers:
Link: *58
'304': *37
@@ -102408,7 +101777,7 @@ paths:
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- *239
- - *685
+ - *680
responses:
'204':
description: Response
@@ -102523,7 +101892,7 @@ paths:
- docker
- nuget
- container
- - *686
+ - *681
- *19
- *17
responses:
@@ -102535,8 +101904,8 @@ paths:
type: array
items: *245
examples:
- default: *687
- '400': *688
+ default: *682
+ '400': *683
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -102565,7 +101934,7 @@ paths:
application/json:
schema: *245
examples:
- default: &704
+ default: &699
value:
id: 40201
name: octo-name
@@ -102927,9 +102296,9 @@ paths:
application/json:
schema:
type: array
- items: *677
+ items: *672
examples:
- default: *689
+ default: *684
headers:
Link: *58
'304': *37
@@ -103042,7 +102411,7 @@ paths:
type: array
items: *70
examples:
- default: &696
+ default: &691
summary: Default response
value:
- id: 1296269
@@ -103346,9 +102715,9 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -103386,9 +102755,9 @@ paths:
application/json:
schema:
type: array
- items: *529
+ items: *526
examples:
- default: *690
+ default: *685
headers:
Link: *58
'304': *37
@@ -103467,7 +102836,7 @@ paths:
application/json:
schema:
type: array
- items: &691
+ items: &686
title: Social account
description: Social media account
type: object
@@ -103482,7 +102851,7 @@ paths:
- provider
- url
examples:
- default: &692
+ default: &687
value:
- provider: twitter
url: https://twitter.com/github
@@ -103544,9 +102913,9 @@ paths:
application/json:
schema:
type: array
- items: *691
+ items: *686
examples:
- default: *692
+ default: *687
'422': *15
'304': *37
'404': *6
@@ -103633,7 +103002,7 @@ paths:
application/json:
schema:
type: array
- items: &693
+ items: &688
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -103653,7 +103022,7 @@ paths:
- title
- created_at
examples:
- default: &722
+ default: &717
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103717,9 +103086,9 @@ paths:
description: Response
content:
application/json:
- schema: *693
+ schema: *688
examples:
- default: &694
+ default: &689
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103749,7 +103118,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:
- - &695
+ - &690
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -103761,9 +103130,9 @@ paths:
description: Response
content:
application/json:
- schema: *693
+ schema: *688
examples:
- default: *694
+ default: *689
'404': *6
'304': *37
'403': *29
@@ -103786,7 +103155,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:
- - *695
+ - *690
responses:
'204':
description: Response
@@ -103815,7 +103184,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &723
+ - &718
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
@@ -103840,11 +103209,11 @@ paths:
type: array
items: *70
examples:
- default-response: *696
+ default-response: *691
application/vnd.github.v3.star+json:
schema:
type: array
- items: &724
+ items: &719
title: Starred Repository
description: Starred Repository
type: object
@@ -104000,8 +103369,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response if this repository is starred by you
@@ -104029,8 +103398,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -104054,8 +103423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -104213,10 +103582,10 @@ paths:
application/json:
schema:
oneOf:
- - *670
- - *669
+ - *665
+ - *664
examples:
- default-response: &698
+ default-response: &693
summary: Default response
value:
login: octocat
@@ -104251,7 +103620,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &699
+ response-with-git-hub-plan-information: &694
summary: Response with GitHub plan information
value:
login: octocat
@@ -104373,7 +103742,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *697
+ - *692
- *17
responses:
'200':
@@ -104422,11 +103791,11 @@ paths:
application/json:
schema:
oneOf:
- - *670
- - *669
+ - *665
+ - *664
examples:
- default-response: *698
- response-with-git-hub-plan-information: *699
+ default-response: *693
+ response-with-git-hub-plan-information: *694
'404': *6
x-github:
githubCloudOnly: false
@@ -104476,8 +103845,8 @@ paths:
required:
- subject_digests
examples:
- default: *700
- withPredicateType: *701
+ default: *695
+ withPredicateType: *696
responses:
'200':
description: Response
@@ -104530,7 +103899,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *702
+ default: *697
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104735,7 +104104,7 @@ paths:
initiator:
type: string
examples:
- default: *391
+ default: *388
'201':
description: Response
content:
@@ -104776,7 +104145,7 @@ paths:
type: array
items: *245
examples:
- default: *687
+ default: *682
'403': *29
'401': *25
x-github:
@@ -105160,9 +104529,9 @@ paths:
application/json:
schema:
type: array
- items: *678
+ items: *673
examples:
- default: *703
+ default: *698
headers:
Link: *58
x-github:
@@ -105266,7 +104635,7 @@ paths:
application/json:
schema: *22
examples:
- default: *526
+ default: *523
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105390,7 +104759,7 @@ paths:
- docker
- nuget
- container
- - *686
+ - *681
- *63
- *19
- *17
@@ -105403,10 +104772,10 @@ paths:
type: array
items: *245
examples:
- default: *687
+ default: *682
'403': *29
'401': *25
- '400': *688
+ '400': *683
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105436,7 +104805,7 @@ paths:
application/json:
schema: *245
examples:
- default: *704
+ default: *699
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105785,7 +105154,7 @@ paths:
type: array
items: *267
examples:
- default: *705
+ default: *700
headers:
Link: *58
'304': *37
@@ -105845,7 +105214,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *706
+ items: *701
required:
- name
- data_type
@@ -105861,7 +105230,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *707
+ iteration_configuration: *702
required:
- name
- data_type
@@ -105883,8 +105252,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *708
- iteration_field: *709
+ single_select_field: *703
+ iteration_field: *704
responses:
'201':
description: Response
@@ -105892,11 +105261,11 @@ paths:
application/json:
schema: *267
examples:
- text_field: *710
- number_field: *711
- date_field: *712
- single_select_field: *713
- iteration_field: *714
+ text_field: *705
+ number_field: *706
+ date_field: *707
+ single_select_field: *708
+ iteration_field: *709
'304': *37
'403': *29
'401': *25
@@ -105918,7 +105287,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-user
parameters:
- *263
- - *715
+ - *710
- *63
responses:
'200':
@@ -105927,7 +105296,7 @@ paths:
application/json:
schema: *267
examples:
- default: *716
+ default: *711
headers:
Link: *58
'304': *37
@@ -106277,7 +105646,7 @@ paths:
parameters:
- *263
- *63
- - *717
+ - *712
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -106552,7 +105921,7 @@ paths:
- *114
- *116
- *115
- - *718
+ - *713
- *117
responses:
'200':
@@ -106683,7 +106052,7 @@ paths:
parameters:
- *63
- *114
- - *719
+ - *714
- *115
responses:
'200':
@@ -106782,9 +106151,9 @@ paths:
- *114
- *116
- *115
- - *720
+ - *715
- *117
- - *721
+ - *716
responses:
'200':
description: Response when getting a billing usage summary
@@ -106918,9 +106287,9 @@ paths:
application/json:
schema:
type: array
- items: *691
+ items: *686
examples:
- default: *692
+ default: *687
headers:
Link: *58
x-github:
@@ -106950,9 +106319,9 @@ paths:
application/json:
schema:
type: array
- items: *693
+ items: *688
examples:
- default: *722
+ default: *717
headers:
Link: *58
x-github:
@@ -106977,7 +106346,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *63
- - *723
+ - *718
- *52
- *17
- *19
@@ -106989,11 +106358,11 @@ paths:
schema:
anyOf:
- type: array
- items: *724
+ items: *719
- type: array
items: *70
examples:
- default-response: *696
+ default-response: *691
headers:
Link: *58
x-github:
@@ -107152,7 +106521,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &725
+ enterprise: &720
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -107210,7 +106579,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &726
+ installation: &721
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -107229,7 +106598,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &727
+ organization: &722
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -107289,13 +106658,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &728
+ repository: &723
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: &758
+ properties: &753
id:
description: Unique identifier of the repository
example: 42
@@ -107978,7 +107347,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &759
+ required: &754
- archive_url
- assignees_url
- blobs_url
@@ -108129,10 +107498,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -108208,11 +107577,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- rule: &729
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ rule: &724
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)
@@ -108435,11 +107804,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- rule: *729
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ rule: *724
sender: *4
required:
- action
@@ -108622,11 +107991,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- rule: *729
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ rule: *724
sender: *4
required:
- action
@@ -108710,7 +108079,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &731
+ check_run: &726
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -108801,7 +108170,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *730
+ deployment: *725
details_url:
example: https://example.com
type: string
@@ -108886,10 +108255,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
sender: *4
required:
- check_run
@@ -109282,11 +108651,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *731
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ check_run: *726
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
sender: *4
required:
- check_run
@@ -109682,11 +109051,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *731
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ check_run: *726
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
requested_action:
description: The action requested by the user.
type: object
@@ -110091,11 +109460,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *731
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ check_run: *726
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
sender: *4
required:
- check_run
@@ -111072,10 +110441,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -111769,10 +111138,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -112460,10 +111829,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -112629,7 +111998,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -112774,20 +112143,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &732
+ commit_oid: &727
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: *725
- installation: *726
- organization: *727
- ref: &733
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: &728
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: *728
+ repository: *723
sender: *4
required:
- action
@@ -112952,7 +112321,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -113182,12 +112551,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -113282,7 +112651,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -113453,12 +112822,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -113624,7 +112993,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -113790,12 +113159,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -113894,7 +113263,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -114069,16 +113438,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
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: *728
+ repository: *723
sender: *4
required:
- action
@@ -114175,7 +113544,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -114315,12 +113684,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -114486,7 +113855,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -114631,10 +114000,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -114889,10 +114258,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -114972,18 +114341,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *727
- pusher_type: &734
+ organization: *722
+ pusher_type: &729
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &735
+ ref: &730
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -114993,7 +114362,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *728
+ repository: *723
sender: *4
required:
- ref
@@ -115076,9 +114445,9 @@ x-webhooks:
enum:
- created
definition: *274
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115163,9 +114532,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115243,9 +114612,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *274
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115323,9 +114692,9 @@ x-webhooks:
enum:
- updated
definition: *274
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115402,10 +114771,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- repository: *728
- organization: *727
+ enterprise: *720
+ installation: *721
+ repository: *723
+ organization: *722
sender: *4
new_property_values:
type: array
@@ -115490,18 +114859,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- pusher_type: *734
- ref: *735
+ enterprise: *720
+ installation: *721
+ organization: *722
+ pusher_type: *729
+ ref: *730
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *728
+ repository: *723
sender: *4
required:
- ref
@@ -115585,11 +114954,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115673,11 +115042,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115761,11 +115130,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115847,11 +115216,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115933,11 +115302,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -116020,11 +115389,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -116106,11 +115475,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -116187,9 +115556,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- key: &736
+ enterprise: *720
+ installation: *721
+ key: &731
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -116225,8 +115594,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -116303,11 +115672,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- key: *736
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ key: *731
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -116868,12 +116237,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: &740
+ workflow: &735
title: Workflow
type: object
nullable: true
@@ -117599,13 +116968,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *491
+ deployment: *488
pull_requests:
type: array
- items: *579
- repository: *728
- organization: *727
- installation: *726
+ items: *576
+ repository: *723
+ organization: *722
+ installation: *721
sender: *4
responses:
'200':
@@ -117676,7 +117045,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &737
+ approver: &732
type: object
properties:
avatar_url:
@@ -117719,11 +117088,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- reviewers: &738
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ reviewers: &733
type: array
items:
type: object
@@ -117802,7 +117171,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &739
+ workflow_job_run: &734
type: object
properties:
conclusion:
@@ -118533,18 +117902,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *737
+ approver: *732
comment:
type: string
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- reviewers: *738
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ reviewers: *733
sender: *4
since:
type: string
- workflow_job_run: *739
+ workflow_job_run: *734
workflow_job_runs:
type: array
items:
@@ -119248,13 +118617,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *725
+ enterprise: *720
environment:
type: string
- installation: *726
- organization: *727
- repository: *728
- requestor: &745
+ installation: *721
+ organization: *722
+ repository: *723
+ requestor: &740
title: User
type: object
nullable: true
@@ -121153,12 +120522,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Deployment Workflow Run
type: object
@@ -121838,7 +121207,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &743
+ answer: &738
type: object
properties:
author_association:
@@ -121995,11 +121364,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122126,11 +121495,11 @@ x-webhooks:
- from
required:
- category
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122213,11 +121582,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122299,7 +121668,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &742
+ comment: &737
type: object
properties:
author_association:
@@ -122456,11 +121825,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122543,12 +121912,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *742
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ comment: *737
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122643,12 +122012,12 @@ x-webhooks:
- from
required:
- body
- comment: *742
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ comment: *737
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122732,11 +122101,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122818,11 +122187,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122922,11 +122291,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123008,10 +122377,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *741
- enterprise: *725
- installation: *726
- label: &744
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ label: &739
title: Label
type: object
properties:
@@ -123043,8 +122412,8 @@ x-webhooks:
- color
- default
- description
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123127,11 +122496,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123213,11 +122582,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123299,11 +122668,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123388,16 +122757,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *741
- new_repository: *728
+ new_discussion: *736
+ new_repository: *723
required:
- new_discussion
- new_repository
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123480,10 +122849,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *741
- old_answer: *743
- organization: *727
- repository: *728
+ discussion: *736
+ old_answer: *738
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123565,12 +122934,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *741
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123653,11 +123022,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123739,11 +123108,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123816,7 +123185,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *725
+ enterprise: *720
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -124476,9 +123845,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- forkee
@@ -124624,9 +123993,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pages:
description: The pages that were updated.
type: array
@@ -124663,7 +124032,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *728
+ repository: *723
sender: *4
required:
- pages
@@ -124739,10 +124108,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: &746
+ organization: *722
+ repositories: &741
description: An array of repository objects that the installation
can access.
type: array
@@ -124768,8 +124137,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *728
- requester: *745
+ repository: *723
+ requester: *740
sender: *4
required:
- action
@@ -124844,11 +124213,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -124924,11 +124293,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -125004,10 +124373,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories_added: &747
+ organization: *722
+ repositories_added: &742
description: An array of repository objects, which were added to
the installation.
type: array
@@ -125053,15 +124422,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *728
- repository_selection: &748
+ repository: *723
+ repository_selection: &743
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *745
+ requester: *740
sender: *4
required:
- action
@@ -125140,10 +124509,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories_added: *747
+ organization: *722
+ repositories_added: *742
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -125170,9 +124539,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *728
- repository_selection: *748
- requester: *745
+ repository: *723
+ repository_selection: *743
+ requester: *740
sender: *4
required:
- action
@@ -125251,11 +124620,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -125433,10 +124802,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
target_type:
type: string
@@ -125515,11 +124884,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -125771,8 +125140,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -126566,8 +125935,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126916,8 +126285,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -126997,7 +126366,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &749
+ comment: &744
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -127162,8 +126531,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -127953,8 +127322,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128305,8 +127674,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -128386,7 +127755,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &778
+ changes: &773
description: The changes to the comment.
type: object
properties:
@@ -128398,9 +127767,9 @@ x-webhooks:
type: string
required:
- from
- comment: *749
- enterprise: *725
- installation: *726
+ comment: *744
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -129193,8 +128562,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129543,8 +128912,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129634,9 +129003,9 @@ x-webhooks:
type: number
blocking_issue: *74
blocking_issue_repo: *70
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129725,9 +129094,9 @@ x-webhooks:
type: number
blocking_issue: *74
blocking_issue_repo: *70
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129815,9 +129184,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129906,9 +129275,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129988,10 +129357,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *745
- enterprise: *725
- installation: *726
- issue: &752
+ assignee: *740
+ enterprise: *720
+ installation: *721
+ issue: &747
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -130780,11 +130149,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -130901,8 +130270,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -130982,8 +130351,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -131777,11 +131146,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132033,8 +131402,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -132113,8 +131482,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -132899,11 +132268,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -133019,8 +132388,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -133099,8 +132468,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -133907,11 +133276,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134006,7 +133375,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &750
+ milestone: &745
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -134144,8 +133513,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -134244,8 +133613,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -135034,11 +134403,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -135155,9 +134524,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *744
- organization: *727
- repository: *728
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -135237,8 +134606,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -136026,11 +135395,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -136147,9 +135516,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *744
- organization: *727
- repository: *728
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -136229,8 +135598,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -137042,11 +136411,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -137140,8 +136509,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -137220,8 +136589,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -138027,11 +137396,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -138125,9 +137494,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *750
- organization: *727
- repository: *728
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -138995,11 +138364,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -139561,8 +138930,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -140351,11 +139720,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -140471,8 +139840,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -140552,9 +139921,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *725
- installation: *726
- issue: &751
+ enterprise: *720
+ installation: *721
+ issue: &746
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -141337,11 +140706,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -141457,8 +140826,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -141537,8 +140906,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -142348,11 +141717,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -142447,8 +141816,8 @@ x-webhooks:
user_view_type:
type: string
type: *227
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -143314,11 +142683,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143902,11 +143271,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *725
- installation: *726
- issue: *751
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *746
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -143986,12 +143355,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *725
- installation: *726
- issue: *752
+ enterprise: *720
+ installation: *721
+ issue: *747
type: *227
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -144072,7 +143441,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &781
+ assignee: &776
title: User
type: object
nullable: true
@@ -144142,11 +143511,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *725
- installation: *726
- issue: *752
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *747
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -144225,12 +143594,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *725
- installation: *726
- issue: *752
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *747
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -144310,8 +143679,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -145121,11 +144490,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145219,8 +144588,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145300,11 +144669,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *725
- installation: *726
- issue: *751
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *746
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145383,12 +144752,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *725
- installation: *726
- issue: *752
+ enterprise: *720
+ installation: *721
+ issue: *747
type: *227
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145468,11 +144837,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145550,11 +144919,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145664,11 +145033,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145750,9 +145119,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: &753
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: &748
title: Marketplace Purchase
type: object
required:
@@ -145835,8 +145204,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *727
- previous_marketplace_purchase: &754
+ organization: *722
+ previous_marketplace_purchase: &749
title: Marketplace Purchase
type: object
properties:
@@ -145916,7 +145285,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -145996,10 +145365,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: *753
- organization: *727
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: *748
+ organization: *722
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -146082,7 +145451,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -146164,10 +145533,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: *753
- organization: *727
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: *748
+ organization: *722
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -146249,7 +145618,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -146330,8 +145699,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -146413,9 +145782,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *727
- previous_marketplace_purchase: *754
- repository: *728
+ organization: *722
+ previous_marketplace_purchase: *749
+ repository: *723
sender: *4
required:
- action
@@ -146495,12 +145864,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: *753
- organization: *727
- previous_marketplace_purchase: *754
- repository: *728
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: *748
+ organization: *722
+ previous_marketplace_purchase: *749
+ repository: *723
sender: *4
required:
- action
@@ -146602,11 +145971,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -146706,11 +146075,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -146789,11 +146158,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -146871,11 +146240,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -146951,7 +146320,7 @@ x-webhooks:
required:
- login
- id
- team: &755
+ team: &750
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -147174,11 +146543,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -147255,7 +146624,7 @@ x-webhooks:
required:
- login
- id
- team: *755
+ team: *750
required:
- action
- scope
@@ -147337,8 +146706,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *726
- merge_group: &757
+ installation: *721
+ merge_group: &752
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -147357,15 +146726,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *756
+ head_commit: *751
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -147451,10 +146820,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *726
- merge_group: *757
- organization: *727
- repository: *728
+ installation: *721
+ merge_group: *752
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -147527,7 +146896,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
+ enterprise: *720
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -147636,16 +147005,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -147726,11 +147095,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
- milestone: *750
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -147809,9 +147178,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- milestone: &760
+ enterprise: *720
+ installation: *721
+ milestone: &755
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -147948,8 +147317,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148028,11 +147397,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- milestone: *750
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148142,11 +147511,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- milestone: *750
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148226,11 +147595,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *725
- installation: *726
- milestone: *760
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *755
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148309,11 +147678,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *745
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ blocked_user: *740
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148392,11 +147761,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *745
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ blocked_user: *740
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148475,9 +147844,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- membership: &761
+ enterprise: *720
+ installation: *721
+ membership: &756
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -148584,8 +147953,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148663,11 +148032,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *725
- installation: *726
- membership: *761
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ membership: *756
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148746,8 +148115,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -148863,10 +148232,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
- user: *745
+ user: *740
required:
- action
- invitation
@@ -148944,11 +148313,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *725
- installation: *726
- membership: *761
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ membership: *756
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -149035,11 +148404,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *725
- installation: *726
- membership: *761
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ membership: *756
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -149115,9 +148484,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
package:
description: Information about the package.
type: object
@@ -149616,7 +148985,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &762
+ items: &757
title: Ruby Gems metadata
type: object
properties:
@@ -149711,7 +149080,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -149787,9 +149156,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
package:
description: Information about the package.
type: object
@@ -150142,7 +149511,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *762
+ items: *757
source_url:
type: string
format: uri
@@ -150212,7 +149581,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -150389,12 +149758,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *725
+ enterprise: *720
id:
type: integer
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- id
@@ -150471,7 +149840,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &763
+ personal_access_token_request: &758
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -150617,10 +149986,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *725
- organization: *727
+ enterprise: *720
+ organization: *722
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150697,11 +150066,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *763
- enterprise: *725
- organization: *727
+ personal_access_token_request: *758
+ enterprise: *720
+ organization: *722
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150777,11 +150146,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *763
- enterprise: *725
- organization: *727
+ personal_access_token_request: *758
+ enterprise: *720
+ organization: *722
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150856,11 +150225,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *763
- organization: *727
- enterprise: *725
+ personal_access_token_request: *758
+ organization: *722
+ enterprise: *720
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150965,7 +150334,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *764
+ last_response: *759
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -150997,8 +150366,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
zen:
description: Random string of GitHub zen.
@@ -151243,10 +150612,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *725
- installation: *726
- organization: *727
- project_card: &765
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_card: &760
title: Project Card
type: object
properties:
@@ -151365,7 +150734,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -151446,11 +150815,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- project_card: *765
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_card: *760
+ repository: *723
sender: *4
required:
- action
@@ -151530,9 +150899,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
project_card:
title: Project Card
type: object
@@ -151660,8 +151029,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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -151755,11 +151124,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *725
- installation: *726
- organization: *727
- project_card: *765
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_card: *760
+ repository: *723
sender: *4
required:
- action
@@ -151853,9 +151222,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
project_card:
allOf:
- title: Project Card
@@ -152045,7 +151414,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -152125,10 +151494,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
- organization: *727
- project: &767
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: &762
title: Project
type: object
properties:
@@ -152252,7 +151621,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -152332,10 +151701,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- project_column: &766
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: &761
title: Project Column
type: object
properties:
@@ -152374,7 +151743,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -152453,18 +151822,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- project_column: *766
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: *761
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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -152554,11 +151923,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- project_column: *766
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: *761
+ repository: *723
sender: *4
required:
- action
@@ -152638,11 +152007,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *725
- installation: *726
- organization: *727
- project_column: *766
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: *761
+ repository: *723
sender: *4
required:
- action
@@ -152722,11 +152091,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
+ repository: *723
sender: *4
required:
- action
@@ -152806,18 +152175,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -152919,11 +152288,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
+ repository: *723
sender: *4
required:
- action
@@ -153002,11 +152371,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
+ repository: *723
sender: *4
required:
- action
@@ -153087,8 +152456,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153170,8 +152539,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153253,8 +152622,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153372,8 +152741,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153457,7 +152826,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &771
+ changes: &766
type: object
properties:
archived_at:
@@ -153471,9 +152840,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *726
- organization: *727
- projects_v2_item: &768
+ installation: *721
+ organization: *722
+ projects_v2_item: &763
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -153608,9 +152977,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -153692,9 +153061,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -153775,9 +153144,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -153883,7 +153252,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &769
+ - &764
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -153905,7 +153274,7 @@ x-webhooks:
required:
- id
- name
- - &770
+ - &765
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -153939,8 +153308,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *769
- - *770
+ - *764
+ - *765
required:
- field_value
- type: object
@@ -153956,9 +153325,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -154053,9 +153422,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -154138,10 +153507,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *771
- installation: *726
- organization: *727
- projects_v2_item: *768
+ changes: *766
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -154223,8 +153592,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -154306,14 +153675,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *726
- organization: *727
- projects_v2_status_update: &774
+ installation: *721
+ organization: *722
+ projects_v2_status_update: &769
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *772
- required: *773
+ properties: *767
+ required: *768
sender: *4
required:
- action
@@ -154394,9 +153763,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *726
- organization: *727
- projects_v2_status_update: *774
+ installation: *721
+ organization: *722
+ projects_v2_status_update: *769
sender: *4
required:
- action
@@ -154532,9 +153901,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *726
- organization: *727
- projects_v2_status_update: *774
+ installation: *721
+ organization: *722
+ projects_v2_status_update: *769
sender: *4
required:
- action
@@ -154605,10 +153974,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- repository
@@ -154685,13 +154054,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *745
- enterprise: *725
- installation: *726
- number: &775
+ assignee: *740
+ enterprise: *720
+ installation: *721
+ number: &770
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -156974,7 +156343,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -157056,11 +156425,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -159338,7 +158707,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -159420,11 +158789,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -161702,7 +161071,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -161784,13 +161153,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: &776
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: &771
allOf:
- - *579
+ - *576
- type: object
properties:
allow_auto_merge:
@@ -161852,7 +161221,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -161933,12 +161302,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -162018,11 +161387,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *725
- milestone: *561
- number: *775
- organization: *727
- pull_request: &777
+ enterprise: *720
+ milestone: *558
+ number: *770
+ organization: *722
+ pull_request: &772
title: Pull Request
type: object
properties:
@@ -164285,7 +163654,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -164364,11 +163733,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -166650,7 +166019,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -166774,12 +166143,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -166859,11 +166228,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -169130,7 +168499,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -169210,11 +168579,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *725
- installation: *726
- label: *744
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ label: *739
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -171496,7 +170865,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -171577,10 +170946,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -173860,7 +173229,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -173940,12 +173309,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *725
- milestone: *561
- number: *775
- organization: *727
- pull_request: *777
- repository: *728
+ enterprise: *720
+ milestone: *558
+ number: *770
+ organization: *722
+ pull_request: *772
+ repository: *723
sender: *4
required:
- action
@@ -174024,12 +173393,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -174110,12 +173479,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -174195,12 +173564,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -174566,9 +173935,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
type: object
properties:
@@ -176738,7 +176107,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -176818,7 +176187,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &779
+ comment: &774
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -177103,9 +176472,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
type: object
properties:
@@ -179263,7 +178632,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -179343,11 +178712,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *778
- comment: *779
- enterprise: *725
- installation: *726
- organization: *727
+ changes: *773
+ comment: *774
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
type: object
properties:
@@ -181508,7 +180877,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -181589,9 +180958,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -183764,7 +183133,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
+ repository: *723
review:
description: The review that was affected.
type: object
@@ -184011,9 +183380,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -186067,8 +185436,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
- review: &780
+ repository: *723
+ review: &775
description: The review that was affected.
type: object
properties:
@@ -186301,12 +185670,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -188589,7 +187958,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_reviewer:
title: User
type: object
@@ -188673,12 +188042,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -190968,7 +190337,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -191160,12 +190529,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -193450,7 +192819,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_reviewer:
title: User
type: object
@@ -193535,12 +192904,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -195816,7 +195185,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -195997,9 +195366,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -198174,8 +197543,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
- review: *780
+ repository: *723
+ review: *775
sender: *4
required:
- action
@@ -198255,9 +197624,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -200327,7 +199696,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
thread:
type: object
@@ -200714,9 +200083,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -202772,7 +202141,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
thread:
type: object
@@ -203162,10 +202531,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -205436,7 +204805,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -205518,11 +204887,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *781
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ assignee: *776
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -207805,7 +207174,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -207884,11 +207253,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *725
- installation: *726
- label: *744
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ label: *739
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -210161,7 +209530,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -210242,10 +209611,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -212510,7 +211879,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -212710,7 +212079,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *725
+ enterprise: *720
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -212802,8 +212171,8 @@ x-webhooks:
- url
- author
- committer
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -213378,9 +212747,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
registry_package:
type: object
properties:
@@ -213826,7 +213195,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *762
+ items: *757
summary:
type: string
tag_name:
@@ -213880,7 +213249,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -213958,9 +213327,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
registry_package:
type: object
properties:
@@ -214268,7 +213637,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *762
+ items: *757
summary:
type: string
tag_name:
@@ -214317,7 +213686,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -214394,10 +213763,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- release: &782
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: &777
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -214715,7 +214084,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -214792,11 +214161,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- release: *782
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *777
+ repository: *723
sender: *4
required:
- action
@@ -214913,11 +214282,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *725
- installation: *726
- organization: *727
- release: *782
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *777
+ repository: *723
sender: *4
required:
- action
@@ -214995,9 +214364,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -215319,7 +214688,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -215395,10 +214764,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
- release: &783
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: &778
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -215717,7 +215086,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -215793,11 +215162,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *725
- installation: *726
- organization: *727
- release: *782
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *777
+ repository: *723
sender: *4
required:
- action
@@ -215873,11 +215242,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *725
- installation: *726
- organization: *727
- release: *783
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *778
+ repository: *723
sender: *4
required:
- action
@@ -215953,11 +215322,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- repository_advisory: *643
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ repository_advisory: *640
sender: *4
required:
- action
@@ -216033,11 +215402,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- repository_advisory: *643
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ repository_advisory: *640
sender: *4
required:
- action
@@ -216113,10 +215482,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216193,10 +215562,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216274,10 +215643,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216361,10 +215730,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216476,10 +215845,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216551,10 +215920,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
status:
type: string
@@ -216635,10 +216004,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216715,10 +216084,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216812,10 +216181,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216895,10 +216264,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
repository_ruleset: *307
sender: *4
required:
@@ -216977,10 +216346,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
repository_ruleset: *307
sender: *4
required:
@@ -217059,10 +216428,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
repository_ruleset: *307
changes:
type: object
@@ -217124,16 +216493,16 @@ x-webhooks:
properties:
added:
type: array
- items: *599
+ items: *596
deleted:
type: array
- items: *599
+ items: *596
updated:
type: array
items:
type: object
properties:
- rule: *599
+ rule: *596
changes:
type: object
properties:
@@ -217367,10 +216736,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217448,10 +216817,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217529,7 +216898,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &784
+ alert: &779
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -217650,10 +217019,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217859,10 +217228,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217940,11 +217309,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *784
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *779
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218143,10 +217512,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218224,7 +217593,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &785
+ alert: &780
type: object
properties:
number: *169
@@ -218343,10 +217712,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218424,11 +217793,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218509,11 +217878,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *785
- installation: *726
- location: *786
- organization: *727
- repository: *728
+ alert: *780
+ installation: *721
+ location: *781
+ organization: *722
+ repository: *723
sender: *4
required:
- location
@@ -218751,11 +218120,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218833,11 +218202,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218915,11 +218284,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218997,12 +218366,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *785
+ alert: *780
assignee: *4
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -219080,11 +218449,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -219210,10 +218579,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *728
- enterprise: *725
- installation: *726
- organization: *727
+ repository: *723
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -219291,11 +218660,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- security_advisory: &787
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ security_advisory: &782
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -219478,11 +218847,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- security_advisory: *787
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ security_advisory: *782
sender: *4
required:
- action
@@ -219555,10 +218924,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -219743,10 +219112,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *280
- enterprise: *725
- installation: *726
- organization: *727
- repository: *333
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *330
sender: *4
required:
- changes
@@ -219824,12 +219193,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: &788
+ sponsorship: &783
type: object
properties:
created_at:
@@ -220130,12 +219499,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- sponsorship
@@ -220223,12 +219592,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- changes
@@ -220305,17 +219674,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &789
+ effective_date: &784
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: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- sponsorship
@@ -220389,7 +219758,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &790
+ changes: &785
type: object
properties:
tier:
@@ -220433,13 +219802,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *789
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ effective_date: *784
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- changes
@@ -220516,13 +219885,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *790
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ changes: *785
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- changes
@@ -220596,10 +219965,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -220682,10 +220051,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -221105,15 +220474,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *725
+ enterprise: *720
id:
description: The unique identifier of the status.
type: integer
- installation: *726
+ installation: *721
name:
type: string
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
sha:
description: The Commit SHA.
@@ -221228,9 +220597,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221320,9 +220689,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221412,9 +220781,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221504,9 +220873,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221583,12 +220952,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- team: &791
+ team: &786
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -221811,9 +221180,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -222271,7 +221640,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -222347,9 +221716,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -222807,7 +222176,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -222884,9 +222253,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -223344,7 +222713,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -223488,9 +222857,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -223948,7 +223317,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- changes
@@ -224026,9 +223395,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -224486,7 +223855,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -224562,10 +223931,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -224638,16 +224007,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *725
+ enterprise: *720
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
ref:
type: string
- repository: *728
+ repository: *723
sender: *4
workflow:
type: string
@@ -224729,10 +224098,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
allOf:
@@ -224969,7 +224338,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225048,10 +224417,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
allOf:
@@ -225311,7 +224680,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225390,10 +224759,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
type: object
@@ -225528,7 +224897,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225607,10 +224976,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
type: object
@@ -225746,7 +225115,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225826,12 +225195,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Workflow Run
type: object
@@ -226830,12 +226199,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Workflow Run
type: object
@@ -227819,12 +227188,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
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 6bb7383dc..1b1074aa4 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json
+++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json
@@ -199306,15 +199306,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -199424,8 +199415,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -199467,8 +199456,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -199732,15 +199719,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -199850,8 +199828,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -199891,8 +199867,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -200122,15 +200096,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -200240,8 +200205,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -200281,8 +200244,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -200536,15 +200497,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -200654,8 +200606,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -200695,8 +200645,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -200787,17 +200735,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-in-org",
+ "operationId": "teams/list-pending-invitations-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
},
"parameters": [
{
@@ -200818,29 +200766,6 @@
"type": "string"
}
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
{
"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).\"",
@@ -200868,11 +200793,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -200994,125 +200945,34 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ ]
},
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "team_count": {
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
},
- "updated_at": {
+ "invitation_teams_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
},
- "url": {
+ "invitation_source": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "example": "\"member\""
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
+ "id",
+ "login",
+ "email",
+ "role",
"created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
]
}
},
@@ -201120,49 +200980,37 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "avatar_url": "https://github.com/images/error/other_user_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",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
}
]
}
@@ -201183,19 +201031,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -201217,298 +201067,175 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "integer"
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
+ },
+ {
+ "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": "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
}
}
- },
+ ],
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "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"
- }
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
+ "email": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
+ "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"
+ ]
+ }
},
"examples": {
"default": {
- "value": {
- "author": {
+ "value": [
+ {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -201527,57 +201254,41 @@
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
}
- }
+ ]
}
}
}
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
}
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
"get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -201599,21 +201310,12 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
@@ -201623,323 +201325,73 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
"value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
}
}
}
}
}
+ },
+ "404": {
+ "description": "if user has no team membership"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment"
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -201961,44 +201413,38 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "body": "Do you like pineapples?"
+ "role": "maintainer"
}
}
}
@@ -202011,1133 +201457,42 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/invitations": {
- "get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-pending-invitations-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "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": "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
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
- },
- "email": {
- "type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": "string",
- "nullable": true
- },
- "failed_reason": {
- "type": "string",
- "nullable": true
- },
- "inviter": {
- "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_count": {
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
- },
- "invitation_teams_url": {
- "type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
- },
- "invitation_source": {
- "type": "string",
- "example": "\"member\""
- }
- },
- "required": [
- "id",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_id"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1,
- "login": "monalisa",
- "node_id": "MDQ6VXNlcjE=",
- "email": "octocat@github.com",
- "role": "direct_member",
- "created_at": "2016-11-30T06:46:10-08:00",
- "failed_at": "",
- "failed_reason": "",
- "inviter": {
- "login": "other_user",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/other_user_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/other_user",
- "html_url": "https://github.com/other_user",
- "followers_url": "https://api.github.com/users/other_user/followers",
- "following_url": "https://api.github.com/users/other_user/following{/other_user}",
- "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
- "organizations_url": "https://api.github.com/users/other_user/orgs",
- "repos_url": "https://api.github.com/users/other_user/repos",
- "events_url": "https://api.github.com/users/other_user/events{/privacy}",
- "received_events_url": "https://api.github.com/users/other_user/received_events",
- "type": "User",
- "site_admin": false
- },
- "team_count": 2,
- "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
- "invitation_source": "member"
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "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": "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
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "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"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "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
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
"url": "https://api.github.com/teams/1/memberships/octocat",
"role": "member",
@@ -528397,2455 +526752,703 @@
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- }
- }
- }
- }
- }
- }
- },
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null,
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "is_verified": true,
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- }
- }
- }
- }
- }
- }
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "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": "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
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- },
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
}
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
+ "201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
- "example": 0
+ "example": 3
},
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
+ "login",
"url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null,
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "is_verified": true,
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
"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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -530854,20 +527457,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-legacy",
+ "operationId": "teams/delete-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -530878,20 +527481,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -530900,22 +527589,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
+ "/teams/{team_id}/discussions": {
"get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List discussions (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-legacy",
+ "operationId": "teams/list-discussions-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
},
"parameters": [
{
@@ -530927,15 +527616,6 @@
"type": "integer"
}
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
{
"name": "direction",
"description": "The direction to sort the results by.",
@@ -530977,8 +527657,8 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -531107,13 +527787,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -531123,41 +527803,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -531216,10 +527911,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -531249,19 +527947,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -531294,20 +527995,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Create a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-legacy",
+ "operationId": "teams/create-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
},
"parameters": [
{
@@ -531318,15 +528019,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -531336,19 +528028,30 @@
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
}
},
"required": [
+ "title",
"body"
]
},
"examples": {
"default": {
"value": {
- "body": "Do you like apples?"
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
}
}
}
@@ -531361,8 +528064,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -531491,13 +528194,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -531507,41 +528210,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -531600,10 +528318,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -531631,19 +528352,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -531668,22 +528392,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/teams/{team_id}/discussions/{discussion_number}": {
"get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-legacy",
+ "operationId": "teams/get-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
},
"parameters": [
{
@@ -531703,15 +528427,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -531720,8 +528435,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -531850,13 +528565,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -531866,41 +528581,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -531959,10 +528689,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -531990,19 +528723,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -532026,20 +528762,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Update a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-legacy",
+ "operationId": "teams/update-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
},
"parameters": [
{
@@ -532059,37 +528795,29 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "body": "Do you like pineapples?"
+ "title": "Welcome to our first team post"
}
}
}
@@ -532102,8 +528830,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -532232,13 +528960,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -532248,41 +528976,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -532341,10 +529084,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -532372,19 +529118,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
"updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -532408,20 +529157,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-legacy",
+ "operationId": "teams/delete-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
},
"parameters": [
{
@@ -532441,15 +529190,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -532463,7 +529203,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
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 7517342b2..24d6a2155 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
+++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
@@ -1021,7 +1021,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &645
+ - &642
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -8795,7 +8795,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
- - &481
+ - &478
name: has
in: query
description: |-
@@ -8911,7 +8911,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &482
+ security_advisory: &479
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -9173,14 +9173,14 @@ paths:
format: date-time
readOnly: true
nullable: true
- auto_dismissed_at: &483
+ auto_dismissed_at: &480
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &484
+ dismissal_request: &481
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -10542,7 +10542,7 @@ paths:
properties:
action:
type: string
- discussion: &741
+ discussion: &736
title: Discussion
description: A Discussion in a repository.
type: object
@@ -10909,7 +10909,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &535
+ properties: &532
id:
type: integer
format: int64
@@ -11286,7 +11286,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &657
+ sub_issues_summary: &654
title: Sub-issues Summary
type: object
properties:
@@ -11306,7 +11306,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &658
+ issue_dependencies_summary: &655
title: Issue Dependencies Summary
type: object
properties:
@@ -11325,7 +11325,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &659
+ items: &656
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -11386,7 +11386,7 @@ paths:
- node_id
- data_type
- value
- required: &536
+ required: &533
- assignee
- closed_at
- comments
@@ -11424,7 +11424,7 @@ paths:
action:
type: string
issue: *74
- comment: &531
+ comment: &528
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -12143,7 +12143,7 @@ paths:
type: string
release:
allOf:
- - &590
+ - &587
title: Release
description: A release.
type: object
@@ -12214,7 +12214,7 @@ paths:
author: *4
assets:
type: array
- items: &591
+ items: &588
title: Release Asset
description: Data related to a release.
type: object
@@ -12805,7 +12805,7 @@ paths:
url:
type: string
format: uri
- user: &669
+ user: &664
title: Public User
description: Public User
type: object
@@ -16110,14 +16110,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &330
+ - &327
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &331
+ - &328
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -16179,7 +16179,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &334
+ '301': &331
description: Moved permanently
content:
application/json:
@@ -16201,7 +16201,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &564
+ - &561
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -16209,7 +16209,7 @@ paths:
schema:
type: boolean
default: false
- - &565
+ - &562
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -16219,7 +16219,7 @@ paths:
type: boolean
default: false
- *81
- - &566
+ - &563
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:
@@ -16693,7 +16693,7 @@ paths:
- url
- subscription_url
examples:
- default: &567
+ default: &564
value:
- id: '1'
repository:
@@ -17707,7 +17707,7 @@ paths:
- property_name
- value
examples:
- default: &573
+ default: &570
value:
- property_name: environment
value: production
@@ -17757,7 +17757,7 @@ paths:
required:
- properties
examples:
- default: &574
+ default: &571
value:
properties:
- property_name: environment
@@ -18318,7 +18318,7 @@ paths:
required: false
schema:
type: string
- - &718
+ - &713
name: model
description: The model name to query usage for. The name is not case sensitive.
in: query
@@ -18464,7 +18464,7 @@ paths:
parameters:
- *67
- *114
- - &719
+ - &714
name: month
description: If specified, only return results for a single month. The value
of `month` is an integer between `1` and `12`. If no year is specified the
@@ -18576,7 +18576,7 @@ paths:
- *114
- *116
- *115
- - &720
+ - &715
name: repository
description: The repository name to query for usage in the format owner/repository.
in: query
@@ -18584,7 +18584,7 @@ paths:
schema:
type: string
- *117
- - &721
+ - &716
name: sku
description: The SKU to query for usage.
in: query
@@ -19486,7 +19486,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &341
+ items: &338
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -20678,7 +20678,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &347
+ selected_actions_url: &344
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`
@@ -20761,7 +20761,7 @@ paths:
description: Response
content:
application/json:
- schema: &351
+ schema: &348
type: object
properties:
days:
@@ -20803,7 +20803,7 @@ paths:
required: true
content:
application/json:
- schema: &352
+ schema: &349
type: object
properties:
days:
@@ -20860,7 +20860,7 @@ paths:
required:
- approval_policy
examples:
- default: &353
+ default: &350
value:
approval_policy: first_time_contributors
'404': *6
@@ -20919,7 +20919,7 @@ paths:
description: Response
content:
application/json:
- schema: &354
+ schema: &351
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -20973,7 +20973,7 @@ paths:
required: true
content:
application/json:
- schema: &355
+ schema: &352
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -21608,7 +21608,7 @@ paths:
description: Response
content:
application/json:
- schema: &356
+ schema: &353
type: object
properties:
default_workflow_permissions: &144
@@ -21659,7 +21659,7 @@ paths:
required: false
content:
application/json:
- schema: &357
+ schema: &354
type: object
properties:
default_workflow_permissions: *144
@@ -22148,7 +22148,7 @@ paths:
type: array
items: *151
examples:
- default: &672
+ default: &667
value:
total_count: 1
repositories:
@@ -22790,7 +22790,7 @@ paths:
application/json:
schema:
type: array
- items: &358
+ items: &355
title: Runner Application
description: Runner Application
type: object
@@ -22815,7 +22815,7 @@ paths:
- download_url
- filename
examples:
- default: &359
+ default: &356
value:
- os: osx
architecture: x64
@@ -22901,7 +22901,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &360
+ '201': &357
description: Response
content:
application/json:
@@ -23012,7 +23012,7 @@ paths:
- token
- expires_at
examples:
- default: &361
+ default: &358
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -23051,7 +23051,7 @@ paths:
application/json:
schema: *155
examples:
- default: &362
+ default: &359
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -23085,7 +23085,7 @@ paths:
application/json:
schema: *153
examples:
- default: &363
+ default: &360
value:
id: 23
name: MBP
@@ -23311,7 +23311,7 @@ paths:
- *67
- *152
responses:
- '200': &364
+ '200': &361
description: Response
content:
application/json:
@@ -23368,7 +23368,7 @@ paths:
parameters:
- *67
- *152
- - &365
+ - &362
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -23498,7 +23498,7 @@ paths:
description: Response
content:
application/json:
- schema: &377
+ schema: &374
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -23527,7 +23527,7 @@ paths:
- key_id
- key
examples:
- default: &378
+ default: &375
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -23940,7 +23940,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *67
- - &346
+ - &343
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)."
@@ -25076,12 +25076,12 @@ paths:
required:
- subject_digests
examples:
- default: &700
+ default: &695
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &701
+ withPredicateType: &696
value:
subject_digests:
- sha256:abc123
@@ -25139,7 +25139,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &702
+ default: &697
value:
attestations_subject_digests:
- sha256:abc:
@@ -25488,7 +25488,7 @@ paths:
initiator:
type: string
examples:
- default: &391
+ default: &388
value:
attestations:
- bundle:
@@ -26417,7 +26417,7 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *67
- - &416
+ - &413
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`,
@@ -26427,7 +26427,7 @@ paths:
schema: &176
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &417
+ - &414
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
@@ -26450,7 +26450,7 @@ paths:
be returned.
in: query
required: false
- schema: &419
+ schema: &416
type: string
description: State of a code scanning alert.
enum:
@@ -26473,7 +26473,7 @@ paths:
be returned.
in: query
required: false
- schema: &420
+ schema: &417
type: string
description: Severity of a code scanning alert.
enum:
@@ -26507,7 +26507,7 @@ paths:
updated_at: *171
url: *172
html_url: *173
- instances_url: &421
+ instances_url: &418
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -26530,7 +26530,7 @@ paths:
required: *21
nullable: true
dismissed_at: *175
- dismissed_reason: &422
+ dismissed_reason: &419
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -26539,13 +26539,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &423
+ dismissed_comment: &420
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &424
+ rule: &421
type: object
properties:
id:
@@ -26598,7 +26598,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &425
+ tool: &422
type: object
properties:
name: *176
@@ -26608,26 +26608,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *177
- most_recent_instance: &426
+ most_recent_instance: &423
type: object
properties:
- ref: &418
+ ref: &415
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &436
+ analysis_key: &433
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
this includes the workflow filename and job name.
- environment: &437
+ environment: &434
type: string
description: Identifies the variable values associated with
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &438
+ category: &435
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -26641,7 +26641,7 @@ paths:
properties:
text:
type: string
- location: &439
+ location: &436
type: object
description: Describe a region within a file for the alert.
properties:
@@ -26662,7 +26662,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &440
+ items: &437
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -27951,7 +27951,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &452
+ properties: &449
name:
type: string
description: The name of the machine.
@@ -27993,7 +27993,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &453
+ required: &450
- name
- display_name
- operating_system
@@ -28861,7 +28861,7 @@ paths:
- updated_at
- visibility
examples:
- default: &454
+ default: &451
value:
total_count: 2
secrets:
@@ -28899,7 +28899,7 @@ paths:
description: Response
content:
application/json:
- schema: &455
+ schema: &452
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -28928,7 +28928,7 @@ paths:
- key_id
- key
examples:
- default: &456
+ default: &453
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -28960,7 +28960,7 @@ paths:
application/json:
schema: *186
examples:
- default: &458
+ default: &455
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -30573,7 +30573,7 @@ paths:
description: Response
content:
application/json:
- schema: &487
+ schema: &484
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -30590,7 +30590,7 @@ paths:
- key_id
- key
examples:
- default: &488
+ default: &485
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -32390,7 +32390,7 @@ paths:
application/json:
schema: *22
examples:
- default: &526
+ default: &523
value:
id: 1
account:
@@ -32615,7 +32615,7 @@ paths:
required: true
content:
application/json:
- schema: &527
+ schema: &524
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -33468,7 +33468,7 @@ paths:
application/json:
schema: *232
examples:
- default: &451
+ default: &448
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -34717,7 +34717,7 @@ paths:
parameters:
- *67
- *239
- - &685
+ - &680
name: repo_name
description: repo_name parameter
in: path
@@ -35756,7 +35756,7 @@ paths:
- nuget
- container
- *67
- - &686
+ - &681
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -35797,7 +35797,7 @@ paths:
default: *246
'403': *29
'401': *25
- '400': &688
+ '400': &683
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -37589,7 +37589,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &772
+ properties: &767
id:
type: number
description: The unique identifier of the status update.
@@ -37637,7 +37637,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &773
+ required: &768
- id
- node_id
- created_at
@@ -37851,7 +37851,7 @@ paths:
content:
oneOf:
- *74
- - &468
+ - &465
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -38080,7 +38080,7 @@ paths:
- review_comment
- self
author_association: *75
- auto_merge: &576
+ auto_merge: &573
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -38455,7 +38455,7 @@ paths:
- updated_at
- project_url
examples:
- default: &705
+ default: &700
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38632,7 +38632,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &706
+ items: &701
type: object
properties:
name:
@@ -38668,7 +38668,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &707
+ iteration_configuration: &702
type: object
description: The configuration for iteration fields.
properties:
@@ -38717,7 +38717,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &708
+ single_select_field: &703
summary: Create a single select field
value:
name: Priority
@@ -38744,7 +38744,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &709
+ iteration_field: &704
summary: Create an iteration field
value:
name: Sprint
@@ -38770,7 +38770,7 @@ paths:
application/json:
schema: *267
examples:
- text_field: &710
+ text_field: &705
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -38779,7 +38779,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &711
+ number_field: &706
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -38788,7 +38788,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &712
+ date_field: &707
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -38797,7 +38797,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &713
+ single_select_field: &708
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38831,7 +38831,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &714
+ iteration_field: &709
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -38877,7 +38877,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
parameters:
- *263
- - &715
+ - &710
name: field_id
description: The unique identifier of the field.
in: path
@@ -38892,7 +38892,7 @@ paths:
application/json:
schema: *267
examples:
- default: &716
+ default: &711
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -40014,7 +40014,7 @@ paths:
parameters:
- *263
- *67
- - &717
+ - &712
name: view_number
description: The number that identifies the project view.
in: path
@@ -40926,7 +40926,7 @@ paths:
description: Response
content:
application/json:
- schema: &333
+ schema: &330
title: Full Repository
description: Full Repository
type: object
@@ -41319,7 +41319,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &473
+ properties: &470
url:
type: string
format: uri
@@ -41335,7 +41335,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &474
+ required: &471
- url
- key
- name
@@ -41424,7 +41424,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &335
+ default: &332
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -41945,7 +41945,7 @@ paths:
- *67
- *17
- *19
- - &598
+ - &595
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -42226,7 +42226,7 @@ paths:
- repository_property
rules:
type: array
- items: &599
+ items: &596
title: Repository Rule
type: object
description: A repository rule.
@@ -42288,7 +42288,7 @@ paths:
type: string
enum:
- required_linear_history
- - &597
+ - &594
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -43184,7 +43184,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *67
- - &600
+ - &597
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
@@ -43199,7 +43199,7 @@ paths:
in: query
schema:
type: string
- - &601
+ - &598
name: time_period
description: |-
The time period to filter by.
@@ -43215,14 +43215,14 @@ paths:
- week
- month
default: day
- - &602
+ - &599
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
- - &603
+ - &600
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -43242,7 +43242,7 @@ paths:
description: Response
content:
application/json:
- schema: &604
+ schema: &601
title: Rule Suites
description: Response
type: array
@@ -43297,7 +43297,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &605
+ default: &602
value:
- id: 21
actor_id: 12
@@ -43341,7 +43341,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *67
- - &606
+ - &603
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -43357,7 +43357,7 @@ paths:
description: Response
content:
application/json:
- schema: &607
+ schema: &604
title: Rule Suite
description: Response
type: object
@@ -43456,7 +43456,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &608
+ default: &605
value:
id: 21
actor_id: 12
@@ -43702,7 +43702,7 @@ paths:
type: string
format: date-time
examples:
- default: &610
+ default: &607
value:
- version_id: 3
actor:
@@ -43755,7 +43755,7 @@ paths:
description: Response
content:
application/json:
- schema: &611
+ schema: &608
allOf:
- *310
- type: object
@@ -43827,7 +43827,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *67
- - &612
+ - &609
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -43838,7 +43838,7 @@ paths:
enum:
- open
- resolved
- - &613
+ - &610
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -43848,7 +43848,7 @@ paths:
required: false
schema:
type: string
- - &614
+ - &611
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -43857,7 +43857,7 @@ paths:
required: false
schema:
type: string
- - &615
+ - &612
name: assignee
in: query
description: Filters alerts by assignee. Use `*` to get all assigned alerts,
@@ -43876,7 +43876,7 @@ paths:
all-unassigned:
value: none
summary: Filter for all unassigned alerts
- - &616
+ - &613
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.
@@ -43891,7 +43891,7 @@ paths:
- *52
- *19
- *17
- - &617
+ - &614
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
@@ -43901,7 +43901,7 @@ paths:
required: false
schema:
type: string
- - &618
+ - &615
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
@@ -43911,7 +43911,7 @@ paths:
required: false
schema:
type: string
- - &619
+ - &616
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -43920,7 +43920,7 @@ paths:
required: false
schema:
type: string
- - &620
+ - &617
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43929,7 +43929,7 @@ paths:
schema:
type: boolean
default: false
- - &621
+ - &618
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43938,7 +43938,7 @@ paths:
schema:
type: boolean
default: false
- - &622
+ - &619
name: hide_secret
in: query
description: A boolean value representing whether or not to hide literal secrets
@@ -43973,14 +43973,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &623
+ state: &620
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: &624
+ resolution: &621
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -44087,8 +44087,8 @@ paths:
pull request.
'
- oneOf: &625
- - &627
+ oneOf: &622
+ - &624
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -44140,7 +44140,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &628
+ - &625
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -44195,7 +44195,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &629
+ - &626
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -44209,7 +44209,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &630
+ - &627
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -44223,7 +44223,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &631
+ - &628
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -44237,7 +44237,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &632
+ - &629
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -44251,7 +44251,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &633
+ - &630
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -44265,7 +44265,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &634
+ - &631
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -44279,7 +44279,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &635
+ - &632
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -44293,7 +44293,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &636
+ - &633
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -44307,7 +44307,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &637
+ - &634
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -44321,7 +44321,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &638
+ - &635
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -44335,7 +44335,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &639
+ - &636
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -44833,7 +44833,7 @@ paths:
application/json:
schema:
type: array
- items: &643
+ items: &640
description: A repository security advisory.
type: object
properties:
@@ -45124,7 +45124,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &644
+ default: &641
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -46963,13 +46963,6 @@ paths:
does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -47021,8 +47014,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -47035,7 +47026,7 @@ paths:
- updated_at
- url
examples:
- default: &661
+ default: &658
value:
- author:
login: octocat
@@ -47060,8 +47051,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -47171,8 +47160,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -47283,7 +47270,7 @@ paths:
application/json:
schema: *323
examples:
- default: &662
+ default: &659
value:
author:
login: octocat
@@ -47308,8 +47295,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -47364,410 +47349,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - *67
- - *68
- - *325
- - *52
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &326
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *76
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &663
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- headers:
- Link: *58
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: &327
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- - &328
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *327
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- - *328
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: &664
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - *67
- - *68
- - *325
- - *328
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47880,7 +47461,7 @@ paths:
description: Response
content:
application/json:
- schema: &329
+ schema: &326
title: Team Membership
description: Team Membership
type: object
@@ -47907,7 +47488,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &665
+ response-if-user-is-a-team-maintainer: &660
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -47970,9 +47551,9 @@ paths:
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- response-if-users-membership-with-team-is-now-pending: &666
+ response-if-users-membership-with-team-is-now-pending: &661
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -48079,14 +47660,14 @@ paths:
parameters:
- *67
- *68
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &667
+ schema: &662
title: Team Repository
description: A team's access to a repository.
type: object
@@ -48657,8 +48238,8 @@ paths:
parameters:
- *67
- *68
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -48705,8 +48286,8 @@ paths:
parameters:
- *67
- *68
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -48743,7 +48324,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: &668
+ response-if-child-teams-exist: &663
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -48897,7 +48478,7 @@ paths:
resources:
type: object
properties:
- core: &332
+ core: &329
title: Rate Limit
type: object
properties:
@@ -48914,21 +48495,21 @@ paths:
- remaining
- reset
- used
- graphql: *332
- search: *332
- code_search: *332
- source_import: *332
- integration_manifest: *332
- code_scanning_upload: *332
- actions_runner_registration: *332
- scim: *332
- dependency_snapshots: *332
- dependency_sbom: *332
- code_scanning_autofix: *332
+ graphql: *329
+ search: *329
+ code_search: *329
+ source_import: *329
+ integration_manifest: *329
+ code_scanning_upload: *329
+ actions_runner_registration: *329
+ scim: *329
+ dependency_snapshots: *329
+ dependency_sbom: *329
+ code_scanning_autofix: *329
required:
- core
- search
- rate: *332
+ rate: *329
required:
- rate
- resources
@@ -49033,14 +48614,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
default-response:
summary: Default response
@@ -49541,7 +49122,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *334
+ '301': *331
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -49559,8 +49140,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -49807,10 +49388,10 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
- '307': &336
+ default: *332
+ '307': &333
description: Temporary Redirect
content:
application/json:
@@ -49839,8 +49420,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -49862,7 +49443,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *336
+ '307': *333
'404': *6
'409': *51
x-github:
@@ -49886,11 +49467,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- - &369
+ - &366
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -49913,7 +49494,7 @@ paths:
type: integer
artifacts:
type: array
- items: &337
+ items: &334
title: Artifact
description: An artifact
type: object
@@ -49991,7 +49572,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &370
+ default: &367
value:
total_count: 2
artifacts:
@@ -50052,9 +49633,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *330
- - *331
- - &338
+ - *327
+ - *328
+ - &335
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -50066,7 +49647,7 @@ paths:
description: Response
content:
application/json:
- schema: *337
+ schema: *334
examples:
default:
value:
@@ -50104,9 +49685,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *330
- - *331
- - *338
+ - *327
+ - *328
+ - *335
responses:
'204':
description: Response
@@ -50130,9 +49711,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *330
- - *331
- - *338
+ - *327
+ - *328
+ - *335
- name: archive_format
in: path
required: true
@@ -50146,7 +49727,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': &530
+ '410': &527
description: Gone
content:
application/json:
@@ -50171,14 +49752,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &339
+ schema: &336
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -50211,13 +49792,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *339
+ schema: *336
examples:
selected_actions: *42
responses:
@@ -50246,14 +49827,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &340
+ schema: &337
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -50286,13 +49867,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *340
+ schema: *337
examples:
selected_actions: *44
responses:
@@ -50323,14 +49904,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *341
+ schema: *338
examples:
default:
value:
@@ -50356,11 +49937,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- - &342
+ - &339
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/`. To reference
@@ -50394,7 +49975,7 @@ paths:
description: Response
content:
application/json:
- schema: &343
+ schema: &340
title: Repository actions caches
description: Repository actions caches
type: object
@@ -50436,7 +50017,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &344
+ default: &341
value:
total_count: 1
actions_caches:
@@ -50468,23 +50049,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:
- - *330
- - *331
+ - *327
+ - *328
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *342
+ - *339
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: *344
+ default: *341
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50504,8 +50085,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:
- - *330
- - *331
+ - *327
+ - *328
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -50536,9 +50117,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *330
- - *331
- - &345
+ - *327
+ - *328
+ - &342
name: job_id
description: The unique identifier of the job.
in: path
@@ -50550,7 +50131,7 @@ paths:
description: Response
content:
application/json:
- schema: &373
+ schema: &370
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -50857,9 +50438,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *330
- - *331
- - *345
+ - *327
+ - *328
+ - *342
responses:
'302':
description: Response
@@ -50887,9 +50468,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *330
- - *331
- - *345
+ - *327
+ - *328
+ - *342
requestBody:
required: false
content:
@@ -50934,8 +50515,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Status response
@@ -50985,8 +50566,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -51049,8 +50630,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -51068,7 +50649,7 @@ paths:
type: integer
secrets:
type: array
- items: &375
+ items: &372
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -51088,7 +50669,7 @@ paths:
- created_at
- updated_at
examples:
- default: &376
+ default: &373
value:
total_count: 2
secrets:
@@ -51121,9 +50702,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *330
- - *331
- - *346
+ - *327
+ - *328
+ - *343
- *19
responses:
'200':
@@ -51140,7 +50721,7 @@ paths:
type: integer
variables:
type: array
- items: &379
+ items: &376
title: Actions Variable
type: object
properties:
@@ -51170,7 +50751,7 @@ paths:
- created_at
- updated_at
examples:
- default: &380
+ default: &377
value:
total_count: 2
variables:
@@ -51203,8 +50784,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51213,11 +50794,11 @@ paths:
schema:
type: object
properties:
- enabled: &348
+ enabled: &345
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *136
- selected_actions_url: *347
+ selected_actions_url: *344
sha_pinning_required: *137
required:
- enabled
@@ -51246,8 +50827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -51258,7 +50839,7 @@ paths:
schema:
type: object
properties:
- enabled: *348
+ enabled: *345
allowed_actions: *136
sha_pinning_required: *137
required:
@@ -51290,14 +50871,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &349
+ schema: &346
type: object
properties:
access_level:
@@ -51314,7 +50895,7 @@ paths:
required:
- access_level
examples:
- default: &350
+ default: &347
value:
access_level: organization
x-github:
@@ -51338,15 +50919,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *349
+ schema: *346
examples:
- default: *350
+ default: *347
responses:
'204':
description: Response
@@ -51370,14 +50951,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
default:
value:
@@ -51401,8 +50982,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Empty response for successful settings update
@@ -51412,7 +50993,7 @@ paths:
required: true
content:
application/json:
- schema: *352
+ schema: *349
examples:
default:
summary: Set retention days
@@ -51436,8 +51017,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51445,7 +51026,7 @@ paths:
application/json:
schema: *138
examples:
- default: *353
+ default: *350
'404': *6
x-github:
enabledForGitHubApps: true
@@ -51464,8 +51045,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -51499,14 +51080,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *354
+ schema: *351
examples:
default: *139
'403': *29
@@ -51528,13 +51109,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *355
+ schema: *352
examples:
default: *139
responses:
@@ -51560,8 +51141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51588,8 +51169,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -51621,14 +51202,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *356
+ schema: *353
examples:
default: *146
x-github:
@@ -51651,8 +51232,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Success response
@@ -51663,7 +51244,7 @@ paths:
required: true
content:
application/json:
- schema: *357
+ schema: *354
examples:
default: *146
x-github:
@@ -51692,8 +51273,8 @@ paths:
in: query
schema:
type: string
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -51737,8 +51318,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -51746,9 +51327,9 @@ paths:
application/json:
schema:
type: array
- items: *358
+ items: *355
examples:
- default: *359
+ default: *356
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51770,8 +51351,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -51814,7 +51395,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *360
+ '201': *357
'404': *6
'422': *7
'409': *51
@@ -51845,8 +51426,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'201':
description: Response
@@ -51854,7 +51435,7 @@ paths:
application/json:
schema: *155
examples:
- default: *361
+ default: *358
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51882,8 +51463,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'201':
description: Response
@@ -51891,7 +51472,7 @@ paths:
application/json:
schema: *155
examples:
- default: *362
+ default: *359
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51913,8 +51494,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
'200':
@@ -51923,7 +51504,7 @@ paths:
application/json:
schema: *153
examples:
- default: *363
+ default: *360
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51944,8 +51525,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
'204':
@@ -51972,8 +51553,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
'200': *157
@@ -51998,8 +51579,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
requestBody:
required: true
@@ -52048,8 +51629,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
requestBody:
required: true
@@ -52099,11 +51680,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
responses:
- '200': *364
+ '200': *361
'404': *6
x-github:
githubCloudOnly: false
@@ -52130,10 +51711,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:
- - *330
- - *331
+ - *327
+ - *328
- *152
- - *365
+ - *362
responses:
'200': *157
'404': *6
@@ -52161,9 +51742,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *330
- - *331
- - &383
+ - *327
+ - *328
+ - &380
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.
@@ -52171,7 +51752,7 @@ paths:
required: false
schema:
type: string
- - &384
+ - &381
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -52179,7 +51760,7 @@ paths:
required: false
schema:
type: string
- - &385
+ - &382
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -52188,7 +51769,7 @@ paths:
required: false
schema:
type: string
- - &386
+ - &383
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
@@ -52215,7 +51796,7 @@ paths:
- pending
- *17
- *19
- - &387
+ - &384
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)."
@@ -52224,7 +51805,7 @@ paths:
schema:
type: string
format: date-time
- - &366
+ - &363
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -52233,13 +51814,13 @@ paths:
schema:
type: boolean
default: false
- - &388
+ - &385
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &389
+ - &386
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -52262,7 +51843,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &367
+ items: &364
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -52410,7 +51991,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &411
+ properties: &408
id:
type: string
description: SHA for the commit
@@ -52461,7 +52042,7 @@ paths:
- name
- email
nullable: true
- required: &412
+ required: &409
- id
- tree_id
- message
@@ -52508,7 +52089,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &390
+ default: &387
value:
total_count: 1
workflow_runs:
@@ -52744,24 +52325,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *330
- - *331
- - &368
+ - *327
+ - *328
+ - &365
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *366
+ - *363
responses:
'200':
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: &371
+ default: &368
value:
id: 30433642
name: Build
@@ -53002,9 +52583,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'204':
description: Response
@@ -53027,9 +52608,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'200':
description: Response
@@ -53148,9 +52729,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:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'201':
description: Response
@@ -53183,12 +52764,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
- *17
- *19
- - *369
+ - *366
responses:
'200':
description: Response
@@ -53204,9 +52785,9 @@ paths:
type: integer
artifacts:
type: array
- items: *337
+ items: *334
examples:
- default: *370
+ default: *367
headers:
Link: *58
x-github:
@@ -53230,25 +52811,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *330
- - *331
- - *368
- - &372
+ - *327
+ - *328
+ - *365
+ - &369
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *366
+ - *363
responses:
'200':
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: *371
+ default: *368
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53271,10 +52852,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *330
- - *331
- - *368
- - *372
+ - *327
+ - *328
+ - *365
+ - *369
- *17
- *19
responses:
@@ -53292,9 +52873,9 @@ paths:
type: integer
jobs:
type: array
- items: *373
+ items: *370
examples:
- default: &374
+ default: &371
value:
total_count: 1
jobs:
@@ -53407,10 +52988,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *330
- - *331
- - *368
- - *372
+ - *327
+ - *328
+ - *365
+ - *369
responses:
'302':
description: Response
@@ -53438,9 +53019,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'202':
description: Response
@@ -53473,9 +53054,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:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: true
content:
@@ -53542,9 +53123,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'202':
description: Response
@@ -53577,9 +53158,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
- 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
@@ -53609,9 +53190,9 @@ paths:
type: integer
jobs:
type: array
- items: *373
+ items: *370
examples:
- default: *374
+ default: *371
headers:
Link: *58
x-github:
@@ -53636,9 +53217,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'302':
description: Response
@@ -53665,9 +53246,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'204':
description: Response
@@ -53694,9 +53275,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'200':
description: Response
@@ -53756,7 +53337,7 @@ paths:
items:
type: object
properties:
- type: &496
+ type: &493
type: string
description: The type of reviewer.
enum:
@@ -53841,9 +53422,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: true
content:
@@ -53890,7 +53471,7 @@ paths:
application/json:
schema:
type: array
- items: &491
+ items: &488
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -53996,7 +53577,7 @@ paths:
- created_at
- updated_at
examples:
- default: &492
+ default: &489
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -54052,9 +53633,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: false
content:
@@ -54098,9 +53679,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
requestBody:
required: false
content:
@@ -54153,9 +53734,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *330
- - *331
- - *368
+ - *327
+ - *328
+ - *365
responses:
'200':
description: Response
@@ -54292,8 +53873,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -54311,9 +53892,9 @@ paths:
type: integer
secrets:
type: array
- items: *375
+ items: *372
examples:
- default: *376
+ default: *373
headers:
Link: *58
x-github:
@@ -54338,16 +53919,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -54369,17 +53950,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *375
+ schema: *372
examples:
- default: &509
+ default: &506
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -54405,8 +53986,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
requestBody:
required: true
@@ -54464,8 +54045,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'204':
@@ -54491,9 +54072,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *330
- - *331
- - *346
+ - *327
+ - *328
+ - *343
- *19
responses:
'200':
@@ -54510,9 +54091,9 @@ paths:
type: integer
variables:
type: array
- items: *379
+ items: *376
examples:
- default: *380
+ default: *377
headers:
Link: *58
x-github:
@@ -54535,8 +54116,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -54588,17 +54169,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *379
+ schema: *376
examples:
- default: &510
+ default: &507
value:
name: USERNAME
value: octocat
@@ -54624,8 +54205,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
requestBody:
required: true
@@ -54668,8 +54249,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
responses:
'204':
@@ -54695,8 +54276,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -54714,7 +54295,7 @@ paths:
type: integer
workflows:
type: array
- items: &381
+ items: &378
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -54821,9 +54402,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *330
- - *331
- - &382
+ - *327
+ - *328
+ - &379
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -54838,7 +54419,7 @@ paths:
description: Response
content:
application/json:
- schema: *381
+ schema: *378
examples:
default:
value:
@@ -54871,9 +54452,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'204':
description: Response
@@ -54898,9 +54479,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'204':
description: Response
@@ -54951,9 +54532,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'204':
description: Response
@@ -54980,19 +54561,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *330
- - *331
+ - *327
+ - *328
+ - *379
+ - *380
+ - *381
- *382
- *383
+ - *17
+ - *19
- *384
+ - *363
- *385
- *386
- - *17
- - *19
- - *387
- - *366
- - *388
- - *389
responses:
'200':
description: Response
@@ -55008,9 +54589,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *367
+ items: *364
examples:
- default: *390
+ default: *387
headers:
Link: *58
x-github:
@@ -55042,9 +54623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *330
- - *331
- - *382
+ - *327
+ - *328
+ - *379
responses:
'200':
description: Response
@@ -55105,8 +54686,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *52
- *17
- *45
@@ -55270,8 +54851,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -55308,8 +54889,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: assignee
in: path
required: true
@@ -55345,8 +54926,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#create-an-attestation
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -55458,8 +55039,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#list-attestations
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *45
- *46
@@ -55516,7 +55097,7 @@ paths:
initiator:
type: string
examples:
- default: *391
+ default: *388
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -55536,8 +55117,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -55545,7 +55126,7 @@ paths:
application/json:
schema:
type: array
- items: &392
+ items: &389
title: Autolink reference
description: An autolink reference.
type: object
@@ -55599,8 +55180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -55639,9 +55220,9 @@ paths:
description: response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: &393
+ default: &390
value:
id: 1
key_prefix: TICKET-
@@ -55672,9 +55253,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *330
- - *331
- - &394
+ - *327
+ - *328
+ - &391
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -55686,9 +55267,9 @@ paths:
description: Response
content:
application/json:
- schema: *392
+ schema: *389
examples:
- default: *393
+ default: *390
'404': *6
x-github:
githubCloudOnly: false
@@ -55708,9 +55289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *330
- - *331
- - *394
+ - *327
+ - *328
+ - *391
responses:
'204':
description: Response
@@ -55734,8 +55315,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response if Dependabot is enabled
@@ -55783,8 +55364,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -55805,8 +55386,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -55826,8 +55407,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -55865,7 +55446,7 @@ paths:
- url
protected:
type: boolean
- protection: &396
+ protection: &393
title: Branch Protection
description: Branch Protection
type: object
@@ -55907,7 +55488,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &399
+ enforce_admins: &396
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -55922,7 +55503,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &401
+ required_pull_request_reviews: &398
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -55998,7 +55579,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &398
+ restrictions: &395
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -56275,9 +55856,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *330
- - *331
- - &397
+ - *327
+ - *328
+ - &394
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).
@@ -56291,14 +55872,14 @@ paths:
description: Response
content:
application/json:
- schema: &407
+ schema: &404
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &464
+ commit: &461
title: Commit
description: Commit
type: object
@@ -56332,7 +55913,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &395
+ properties: &392
name:
type: string
example: '"Chris Wanstrath"'
@@ -56348,7 +55929,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *395
+ properties: *392
nullable: true
message:
type: string
@@ -56369,7 +55950,7 @@ paths:
required:
- sha
- url
- verification: &516
+ verification: &513
title: Verification
type: object
properties:
@@ -56439,7 +56020,7 @@ paths:
type: integer
files:
type: array
- items: &477
+ items: &474
title: Diff Entry
description: Diff Entry
type: object
@@ -56523,7 +56104,7 @@ paths:
- self
protected:
type: boolean
- protection: *396
+ protection: *393
protection_url:
type: string
format: uri
@@ -56630,7 +56211,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *334
+ '301': *331
'404': *6
x-github:
githubCloudOnly: false
@@ -56652,15 +56233,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
default:
value:
@@ -56854,9 +56435,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -57111,7 +56692,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &404
+ required_status_checks: &401
title: Status Check Policy
description: Status Check Policy
type: object
@@ -57263,7 +56844,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *398
+ restrictions: *395
required_conversation_resolution:
type: object
properties:
@@ -57375,9 +56956,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57402,17 +56983,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: &400
+ default: &397
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -57434,17 +57015,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: *400
+ default: *397
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57463,9 +57044,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57490,17 +57071,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: &402
+ default: &399
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -57596,9 +57177,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -57696,9 +57277,9 @@ paths:
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *15
x-github:
githubCloudOnly: false
@@ -57719,9 +57300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57748,17 +57329,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: &403
+ default: &400
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -57781,17 +57362,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *399
+ schema: *396
examples:
- default: *403
+ default: *400
'404': *6
x-github:
githubCloudOnly: false
@@ -57811,9 +57392,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57838,17 +57419,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: &405
+ default: &402
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -57874,9 +57455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -57928,9 +57509,9 @@ paths:
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'404': *6
'422': *15
x-github:
@@ -57952,9 +57533,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -57978,9 +57559,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58014,9 +57595,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58083,9 +57664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58149,9 +57730,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
content:
application/json:
@@ -58217,15 +57798,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
default:
value:
@@ -58316,9 +57897,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'204':
description: Response
@@ -58341,9 +57922,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58353,7 +57934,7 @@ paths:
type: array
items: *5
examples:
- default: &406
+ default: &403
value:
- id: 1
slug: octoapp
@@ -58410,9 +57991,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58446,7 +58027,7 @@ paths:
type: array
items: *5
examples:
- default: *406
+ default: *403
'422': *15
x-github:
githubCloudOnly: false
@@ -58467,9 +58048,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58503,7 +58084,7 @@ paths:
type: array
items: *5
examples:
- default: *406
+ default: *403
'422': *15
x-github:
githubCloudOnly: false
@@ -58524,9 +58105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58560,7 +58141,7 @@ paths:
type: array
items: *5
examples:
- default: *406
+ default: *403
'422': *15
x-github:
githubCloudOnly: false
@@ -58582,9 +58163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58614,9 +58195,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58675,9 +58256,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: false
content:
@@ -58736,9 +58317,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
content:
application/json:
@@ -58797,9 +58378,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
responses:
'200':
description: Response
@@ -58833,9 +58414,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58893,9 +58474,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -58953,9 +58534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -59015,9 +58596,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
requestBody:
required: true
content:
@@ -59039,7 +58620,7 @@ paths:
description: Response
content:
application/json:
- schema: *407
+ schema: *404
examples:
default:
value:
@@ -59155,8 +58736,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -59435,7 +59016,7 @@ paths:
description: Response
content:
application/json:
- schema: &408
+ schema: &405
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -59555,7 +59136,7 @@ paths:
check.
type: array
items: *79
- deployment: &730
+ deployment: &725
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -59835,9 +59416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *330
- - *331
- - &409
+ - *327
+ - *328
+ - &406
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -59849,9 +59430,9 @@ paths:
description: Response
content:
application/json:
- schema: *408
+ schema: *405
examples:
- default: &410
+ default: &407
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -59951,9 +59532,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *330
- - *331
- - *409
+ - *327
+ - *328
+ - *406
requestBody:
required: true
content:
@@ -60193,9 +59774,9 @@ paths:
description: Response
content:
application/json:
- schema: *408
+ schema: *405
examples:
- default: *410
+ default: *407
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60215,9 +59796,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *330
- - *331
- - *409
+ - *327
+ - *328
+ - *406
- *17
- *19
responses:
@@ -60312,9 +59893,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *330
- - *331
- - *409
+ - *327
+ - *328
+ - *406
responses:
'201':
description: Response
@@ -60358,8 +59939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -60381,7 +59962,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &413
+ schema: &410
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -60467,12 +60048,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &756
+ head_commit: &751
title: Simple Commit
description: A commit.
type: object
- properties: *411
- required: *412
+ properties: *408
+ required: *409
latest_check_runs_count:
type: integer
check_runs_url:
@@ -60500,7 +60081,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &414
+ default: &411
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -60791,9 +60372,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *413
+ schema: *410
examples:
- default: *414
+ default: *411
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60812,8 +60393,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -61122,9 +60703,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *330
- - *331
- - &415
+ - *327
+ - *328
+ - &412
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -61136,9 +60717,9 @@ paths:
description: Response
content:
application/json:
- schema: *413
+ schema: *410
examples:
- default: *414
+ default: *411
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61161,17 +60742,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *330
- - *331
- - *415
- - &470
+ - *327
+ - *328
+ - *412
+ - &467
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &471
+ - &468
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -61210,9 +60791,9 @@ paths:
type: integer
check_runs:
type: array
- items: *408
+ items: *405
examples:
- default: &472
+ default: &469
value:
total_count: 1
check_runs:
@@ -61314,9 +60895,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *330
- - *331
- - *415
+ - *327
+ - *328
+ - *412
responses:
'201':
description: Response
@@ -61349,21 +60930,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *330
- - *331
- - *416
- - *417
+ - *327
+ - *328
+ - *413
+ - *414
- *19
- *17
- - &434
+ - &431
name: ref
description: The Git reference for the results you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
in: query
required: false
- schema: *418
- - &435
+ schema: *415
+ - &432
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -61388,13 +60969,13 @@ paths:
be returned.
in: query
required: false
- schema: *419
+ schema: *416
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *420
+ schema: *417
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -61418,7 +60999,7 @@ paths:
updated_at: *171
url: *172
html_url: *173
- instances_url: *421
+ instances_url: *418
state: *178
fixed_at: *174
dismissed_by:
@@ -61429,11 +61010,11 @@ paths:
required: *21
nullable: true
dismissed_at: *175
- dismissed_reason: *422
- dismissed_comment: *423
- rule: *424
- tool: *425
- most_recent_instance: *426
+ dismissed_reason: *419
+ dismissed_comment: *420
+ rule: *421
+ tool: *422
+ most_recent_instance: *423
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61559,7 +61140,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &427
+ '403': &424
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -61586,9 +61167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *330
- - *331
- - &428
+ - *327
+ - *328
+ - &425
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -61602,7 +61183,7 @@ paths:
description: Response
content:
application/json:
- schema: &429
+ schema: &426
type: object
properties:
number: *169
@@ -61610,7 +61191,7 @@ paths:
updated_at: *171
url: *172
html_url: *173
- instances_url: *421
+ instances_url: *418
state: *178
fixed_at: *174
dismissed_by:
@@ -61621,8 +61202,8 @@ paths:
required: *21
nullable: true
dismissed_at: *175
- dismissed_reason: *422
- dismissed_comment: *423
+ dismissed_reason: *419
+ dismissed_comment: *420
rule:
type: object
properties:
@@ -61676,8 +61257,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *425
- most_recent_instance: *426
+ tool: *422
+ most_recent_instance: *423
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61776,7 +61357,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -61796,9 +61377,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
requestBody:
required: true
content:
@@ -61813,8 +61394,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *422
- dismissed_comment: *423
+ dismissed_reason: *419
+ dismissed_comment: *420
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -61842,7 +61423,7 @@ paths:
description: Response
content:
application/json:
- schema: *429
+ schema: *426
examples:
default:
value:
@@ -61918,7 +61499,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &433
+ '403': &430
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -61945,15 +61526,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:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
responses:
'200':
description: Response
content:
application/json:
- schema: &430
+ schema: &427
type: object
properties:
status:
@@ -61979,13 +61560,13 @@ paths:
- description
- started_at
examples:
- default: &431
+ default: &428
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &432
+ '400': &429
description: Bad Request
content:
application/json:
@@ -61996,7 +61577,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': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62021,29 +61602,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:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
responses:
'200':
description: OK
content:
application/json:
- schema: *430
+ schema: *427
examples:
- default: *431
+ default: *428
'202':
description: Accepted
content:
application/json:
- schema: *430
+ schema: *427
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *432
+ '400': *429
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -62075,9 +61656,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:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
requestBody:
required: false
content:
@@ -62122,8 +61703,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *432
- '403': *433
+ '400': *429
+ '403': *430
'404': *6
'422':
description: Unprocessable Entity
@@ -62147,13 +61728,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
- *19
- *17
- - *434
- - *435
+ - *431
+ - *432
responses:
'200':
description: Response
@@ -62164,10 +61745,10 @@ paths:
items:
type: object
properties:
- ref: *418
- analysis_key: *436
- environment: *437
- category: *438
+ ref: *415
+ analysis_key: *433
+ environment: *434
+ category: *435
state:
type: string
description: State of a code scanning alert instance.
@@ -62182,7 +61763,7 @@ paths:
properties:
text:
type: string
- location: *439
+ location: *436
html_url:
type: string
classifications:
@@ -62190,7 +61771,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: *440
+ items: *437
examples:
default:
value:
@@ -62229,7 +61810,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62263,25 +61844,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *330
- - *331
- - *416
- - *417
+ - *327
+ - *328
+ - *413
+ - *414
- *19
- *17
- - *435
+ - *432
- name: ref
in: query
description: The Git reference for the analyses you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *418
+ schema: *415
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &441
+ schema: &438
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -62302,23 +61883,23 @@ paths:
application/json:
schema:
type: array
- items: &442
+ items: &439
type: object
properties:
- ref: *418
- commit_sha: &450
+ ref: *415
+ commit_sha: &447
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: *436
+ analysis_key: *433
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *438
+ category: *435
error:
type: string
example: error reading field xyz
@@ -62342,8 +61923,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *441
- tool: *425
+ sarif_id: *438
+ tool: *422
deletable:
type: boolean
warning:
@@ -62404,7 +61985,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62440,8 +62021,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:
- - *330
- - *331
+ - *327
+ - *328
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62454,7 +62035,7 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
response:
summary: application/json response
@@ -62508,7 +62089,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *427
+ '403': *424
'404': *6
'422':
description: Response if analysis could not be processed
@@ -62595,8 +62176,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:
- - *330
- - *331
+ - *327
+ - *328
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62649,7 +62230,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': *433
+ '403': *430
'404': *6
'503': *112
x-github:
@@ -62671,8 +62252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -62680,7 +62261,7 @@ paths:
application/json:
schema:
type: array
- items: &443
+ items: &440
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -62791,7 +62372,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': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62820,8 +62401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: language
in: path
description: The language of the CodeQL database.
@@ -62833,7 +62414,7 @@ paths:
description: Response
content:
application/json:
- schema: *443
+ schema: *440
examples:
default:
value:
@@ -62865,9 +62446,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': &479
+ '302': &476
description: Found
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -62889,8 +62470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: language
in: path
description: The language of the CodeQL database.
@@ -62900,7 +62481,7 @@ paths:
responses:
'204':
description: Response
- '403': *433
+ '403': *430
'404': *6
'503': *112
x-github:
@@ -62928,8 +62509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -62938,7 +62519,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &444
+ language: &441
type: string
description: The language targeted by the CodeQL query
enum:
@@ -63018,7 +62599,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &448
+ schema: &445
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -63028,7 +62609,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *57
actor: *4
- query_language: *444
+ query_language: *441
query_pack_url:
type: string
description: The download url for the query pack.
@@ -63075,7 +62656,7 @@ paths:
items:
type: object
properties:
- repository: &445
+ repository: &442
title: Repository Identifier
description: Repository Identifier
type: object
@@ -63111,7 +62692,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &449
+ analysis_status: &446
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -63143,7 +62724,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &446
+ access_mismatch_repos: &443
type: object
properties:
repository_count:
@@ -63157,7 +62738,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: *445
+ items: *442
required:
- repository_count
- repositories
@@ -63179,8 +62760,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *446
- over_limit_repos: *446
+ no_codeql_db_repos: *443
+ over_limit_repos: *443
required:
- access_mismatch_repos
- not_found_repos
@@ -63196,7 +62777,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &447
+ value: &444
summary: Default response
value:
id: 1
@@ -63342,10 +62923,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *447
+ value: *444
repository_lists:
summary: Response for a successful variant analysis submission
- value: *447
+ value: *444
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -63373,8 +62954,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:
- - *330
- - *331
+ - *327
+ - *328
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -63386,9 +62967,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: *447
+ default: *444
'404': *6
'503': *112
x-github:
@@ -63411,7 +62992,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:
- - *330
+ - *327
- name: repo
in: path
description: The name of the controller repository.
@@ -63446,7 +63027,7 @@ paths:
type: object
properties:
repository: *57
- analysis_status: *449
+ analysis_status: *446
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -63571,8 +63152,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -63657,7 +63238,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *427
+ '403': *424
'404': *6
'503': *112
x-github:
@@ -63678,8 +63259,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -63771,7 +63352,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *433
+ '403': *430
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -63842,8 +63423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -63851,7 +63432,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *450
+ commit_sha: *447
ref:
type: string
description: |-
@@ -63909,7 +63490,7 @@ paths:
schema:
type: object
properties:
- id: *441
+ id: *438
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -63923,7 +63504,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': *433
+ '403': *430
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -63946,8 +63527,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -63993,7 +63574,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': *427
+ '403': *424
'404':
description: Not Found if the sarif id does not match any upload
'503': *112
@@ -64018,8 +63599,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -64100,8 +63681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -64221,8 +63802,8 @@ paths:
parameters:
- *17
- *19
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -64536,8 +64117,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -64602,7 +64183,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -64610,7 +64191,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'400': *14
'401': *25
'403': *29
@@ -64639,8 +64220,8 @@ paths:
parameters:
- *17
- *19
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -64704,8 +64285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -64740,14 +64321,14 @@ paths:
type: integer
machines:
type: array
- items: &675
+ items: &670
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *452
- required: *453
+ properties: *449
+ required: *450
examples:
- default: &676
+ default: &671
value:
total_count: 2
machines:
@@ -64787,8 +64368,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -64872,8 +64453,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:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -64939,8 +64520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -64958,7 +64539,7 @@ paths:
type: integer
secrets:
type: array
- items: &457
+ items: &454
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -64978,7 +64559,7 @@ paths:
- created_at
- updated_at
examples:
- default: *454
+ default: *451
headers:
Link: *58
x-github:
@@ -65001,16 +64582,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *455
+ schema: *452
examples:
- default: *456
+ default: *453
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -65030,17 +64611,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65060,8 +64641,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
requestBody:
required: true
@@ -65114,8 +64695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'204':
@@ -65144,8 +64725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -65187,7 +64768,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &459
+ properties: &456
login:
type: string
example: octocat
@@ -65280,7 +64861,7 @@ paths:
user_view_type:
type: string
example: public
- required: &460
+ required: &457
- avatar_url
- events_url
- followers_url
@@ -65354,8 +64935,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
responses:
'204':
@@ -65402,8 +64983,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
requestBody:
required: false
@@ -65430,7 +65011,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &529
+ schema: &526
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -65659,8 +65240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
responses:
'204':
@@ -65692,8 +65273,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *63
responses:
'200':
@@ -65714,8 +65295,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *459
- required: *460
+ properties: *456
+ required: *457
nullable: true
required:
- permission
@@ -65770,8 +65351,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -65781,7 +65362,7 @@ paths:
application/json:
schema:
type: array
- items: &461
+ items: &458
title: Commit Comment
description: Commit Comment
type: object
@@ -65839,7 +65420,7 @@ paths:
- created_at
- updated_at
examples:
- default: &466
+ default: &463
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65898,17 +65479,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'200':
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: &467
+ default: &464
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65965,8 +65546,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -65989,7 +65570,7 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
default:
value:
@@ -66040,8 +65621,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'204':
@@ -66063,8 +65644,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -66091,7 +65672,7 @@ paths:
application/json:
schema:
type: array
- items: &462
+ items: &459
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -66134,7 +65715,7 @@ paths:
- content
- created_at
examples:
- default: &533
+ default: &530
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -66179,8 +65760,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -66213,9 +65794,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: &463
+ default: &460
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -66244,9 +65825,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -66268,10 +65849,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- - &534
+ - &531
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -66326,8 +65907,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -66383,9 +65964,9 @@ paths:
application/json:
schema:
type: array
- items: *464
+ items: *461
examples:
- default: &583
+ default: &580
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -66479,9 +66060,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *330
- - *331
- - &465
+ - *327
+ - *328
+ - &462
name: commit_sha
description: The SHA of the commit.
in: path
@@ -66553,9 +66134,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
- *17
- *19
responses:
@@ -66565,9 +66146,9 @@ paths:
application/json:
schema:
type: array
- items: *461
+ items: *458
examples:
- default: *466
+ default: *463
headers:
Link: *58
x-github:
@@ -66595,9 +66176,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
requestBody:
required: true
content:
@@ -66632,9 +66213,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *467
+ default: *464
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -66662,9 +66243,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
- *17
- *19
responses:
@@ -66674,9 +66255,9 @@ paths:
application/json:
schema:
type: array
- items: *468
+ items: *465
examples:
- default: &575
+ default: &572
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -67213,11 +66794,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *19
- *17
- - &469
+ - &466
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)"
@@ -67232,9 +66813,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: &560
+ default: &557
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -67347,11 +66928,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *330
- - *331
- - *469
- - *470
- - *471
+ - *327
+ - *328
+ - *466
+ - *467
+ - *468
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -67385,9 +66966,9 @@ paths:
type: integer
check_runs:
type: array
- items: *408
+ items: *405
examples:
- default: *472
+ default: *469
headers:
Link: *58
x-github:
@@ -67412,9 +66993,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *330
- - *331
- - *469
+ - *327
+ - *328
+ - *466
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -67422,7 +67003,7 @@ paths:
schema:
type: integer
example: 1
- - *470
+ - *467
- *17
- *19
responses:
@@ -67440,7 +67021,7 @@ paths:
type: integer
check_suites:
type: array
- items: *413
+ items: *410
examples:
default:
value:
@@ -67640,9 +67221,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *330
- - *331
- - *469
+ - *327
+ - *328
+ - *466
- *17
- *19
responses:
@@ -67840,9 +67421,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *330
- - *331
- - *469
+ - *327
+ - *328
+ - *466
- *17
- *19
responses:
@@ -67852,7 +67433,7 @@ paths:
application/json:
schema:
type: array
- items: &648
+ items: &645
title: Status
description: The status of a commit.
type: object
@@ -67933,7 +67514,7 @@ paths:
site_admin: false
headers:
Link: *58
- '301': *334
+ '301': *331
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67961,8 +67542,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -67991,20 +67572,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *473
- required: *474
+ properties: *470
+ required: *471
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &475
+ properties: &472
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &476
+ required: &473
- url
- html_url
nullable: true
@@ -68018,26 +67599,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
readme:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *475
- required: *476
+ properties: *472
+ required: *473
nullable: true
required:
- code_of_conduct
@@ -68164,8 +67745,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *19
- *17
- name: basehead
@@ -68208,8 +67789,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *464
- merge_base_commit: *464
+ base_commit: *461
+ merge_base_commit: *461
status:
type: string
enum:
@@ -68229,10 +67810,10 @@ paths:
example: 6
commits:
type: array
- items: *464
+ items: *461
files:
type: array
- items: *477
+ items: *474
required:
- url
- html_url
@@ -68518,8 +68099,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: path
description: path parameter
in: path
@@ -68662,7 +68243,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &478
+ response-if-content-is-a-file: &475
summary: Response if content is a file
value:
type: file
@@ -68794,7 +68375,7 @@ paths:
- size
- type
- url
- - &588
+ - &585
title: Content File
description: Content File
type: object
@@ -68995,7 +68576,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *478
+ response-if-content-is-a-file: *475
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -69064,7 +68645,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *479
+ '302': *476
'304': *37
x-github:
githubCloudOnly: false
@@ -69087,8 +68668,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: path
description: path parameter
in: path
@@ -69181,7 +68762,7 @@ paths:
description: Response
content:
application/json:
- schema: &480
+ schema: &477
title: File Commit
description: File Commit
type: object
@@ -69333,7 +68914,7 @@ paths:
description: Response
content:
application/json:
- schema: *480
+ schema: *477
examples:
example-for-creating-a-file:
value:
@@ -69387,7 +68968,7 @@ paths:
schema:
oneOf:
- *3
- - &511
+ - &508
description: Repository rule violation was detected
type: object
properties:
@@ -69408,7 +68989,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &640
+ placeholder_id: &637
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -69440,8 +69021,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: path
description: path parameter
in: path
@@ -69502,7 +69083,7 @@ paths:
description: Response
content:
application/json:
- schema: *480
+ schema: *477
examples:
default:
value:
@@ -69557,8 +69138,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -69681,8 +69262,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *190
- *191
- *192
@@ -69694,7 +69275,7 @@ paths:
schema:
type: string
- *194
- - *481
+ - *478
- *195
- *196
- *52
@@ -69715,7 +69296,7 @@ paths:
application/json:
schema:
type: array
- items: &485
+ items: &482
type: object
description: A Dependabot alert.
properties:
@@ -69761,7 +69342,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *482
+ security_advisory: *479
security_vulnerability: *56
url: *172
html_url: *173
@@ -69792,8 +69373,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *174
- auto_dismissed_at: *483
- dismissal_request: *484
+ auto_dismissed_at: *480
+ dismissal_request: *481
required:
- number
- state
@@ -70023,9 +69604,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *330
- - *331
- - &486
+ - *327
+ - *328
+ - &483
name: alert_number
in: path
description: |-
@@ -70040,7 +69621,7 @@ paths:
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
default:
value:
@@ -70153,9 +69734,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *330
- - *331
- - *486
+ - *327
+ - *328
+ - *483
requestBody:
required: true
content:
@@ -70200,7 +69781,7 @@ paths:
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
default:
value:
@@ -70329,8 +69910,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -70348,7 +69929,7 @@ paths:
type: integer
secrets:
type: array
- items: &489
+ items: &486
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -70401,16 +69982,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *487
+ schema: *484
examples:
- default: *488
+ default: *485
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70430,15 +70011,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *489
+ schema: *486
examples:
default:
value:
@@ -70464,8 +70045,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
requestBody:
required: true
@@ -70518,8 +70099,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *159
responses:
'204':
@@ -70542,8 +70123,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:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -70703,8 +70284,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -70943,8 +70524,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -71019,7 +70600,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &490
+ metadata: &487
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -71052,7 +70633,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *490
+ metadata: *487
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -71065,7 +70646,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *490
+ metadata: *487
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -71194,8 +70775,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -71235,9 +70816,9 @@ paths:
application/json:
schema:
type: array
- items: *491
+ items: *488
examples:
- default: *492
+ default: *489
headers:
Link: *58
x-github:
@@ -71303,8 +70884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -71385,7 +70966,7 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
simple-example:
summary: Simple example
@@ -71458,9 +71039,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *330
- - *331
- - &493
+ - *327
+ - *328
+ - &490
name: deployment_id
description: deployment_id parameter
in: path
@@ -71472,7 +71053,7 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
default:
value:
@@ -71537,9 +71118,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
responses:
'204':
description: Response
@@ -71561,9 +71142,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
- *17
- *19
responses:
@@ -71573,7 +71154,7 @@ paths:
application/json:
schema:
type: array
- items: &494
+ items: &491
title: Deployment Status
description: The status of a deployment.
type: object
@@ -71734,9 +71315,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
requestBody:
required: true
content:
@@ -71811,9 +71392,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: &495
+ default: &492
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -71869,9 +71450,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *330
- - *331
- - *493
+ - *327
+ - *328
+ - *490
- name: status_id
in: path
required: true
@@ -71882,9 +71463,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: *495
+ default: *492
'404': *6
x-github:
githubCloudOnly: false
@@ -71909,8 +71490,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -71967,8 +71548,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -71985,7 +71566,7 @@ paths:
type: integer
environments:
type: array
- items: &497
+ items: &494
title: Environment
description: Details of a deployment environment
type: object
@@ -72037,7 +71618,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &499
+ wait_timer: &496
type: integer
example: 30
description: The amount of time to delay a job after
@@ -72074,7 +71655,7 @@ paths:
items:
type: object
properties:
- type: *496
+ type: *493
reviewer:
anyOf:
- *4
@@ -72098,7 +71679,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &500
+ deployment_branch_policy: &497
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -72214,9 +71795,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *330
- - *331
- - &498
+ - *327
+ - *328
+ - &495
name: environment_name
in: path
required: true
@@ -72229,9 +71810,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &501
+ default: &498
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -72315,9 +71896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
requestBody:
required: false
content:
@@ -72326,7 +71907,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *499
+ wait_timer: *496
prevent_self_review:
type: boolean
example: false
@@ -72343,13 +71924,13 @@ paths:
items:
type: object
properties:
- type: *496
+ type: *493
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *500
+ deployment_branch_policy: *497
additionalProperties: false
examples:
default:
@@ -72369,9 +71950,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *501
+ default: *498
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -72395,9 +71976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
responses:
'204':
description: Default response
@@ -72422,9 +72003,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *17
- *19
responses:
@@ -72442,7 +72023,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &502
+ items: &499
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -72499,9 +72080,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
requestBody:
required: true
content:
@@ -72547,9 +72128,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- example-wildcard: &503
+ example-wildcard: &500
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -72591,10 +72172,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
- - &504
+ - *327
+ - *328
+ - *495
+ - &501
name: branch_policy_id
in: path
required: true
@@ -72606,9 +72187,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: *503
+ default: *500
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72627,10 +72208,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
- - *504
+ - *327
+ - *328
+ - *495
+ - *501
requestBody:
required: true
content:
@@ -72658,9 +72239,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: *503
+ default: *500
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72679,10 +72260,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *330
- - *331
- - *498
- - *504
+ - *327
+ - *328
+ - *495
+ - *501
responses:
'204':
description: Response
@@ -72707,9 +72288,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *498
- - *331
- - *330
+ - *495
+ - *328
+ - *327
responses:
'200':
description: List of deployment protection rules
@@ -72725,7 +72306,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &505
+ items: &502
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -72744,7 +72325,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &506
+ app: &503
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -72843,9 +72424,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:
- - *498
- - *331
- - *330
+ - *495
+ - *328
+ - *327
requestBody:
content:
application/json:
@@ -72866,9 +72447,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *505
+ schema: *502
examples:
- default: &507
+ default: &504
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -72903,9 +72484,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:
- - *498
- - *331
- - *330
+ - *495
+ - *328
+ - *327
- *19
- *17
responses:
@@ -72924,7 +72505,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *506
+ items: *503
examples:
default:
value:
@@ -72959,10 +72540,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *330
- - *331
- - *498
- - &508
+ - *327
+ - *328
+ - *495
+ - &505
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -72974,9 +72555,9 @@ paths:
description: Response
content:
application/json:
- schema: *505
+ schema: *502
examples:
- default: *507
+ default: *504
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72997,10 +72578,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *498
- - *331
- - *330
- - *508
+ - *495
+ - *328
+ - *327
+ - *505
responses:
'204':
description: Response
@@ -73026,9 +72607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *17
- *19
responses:
@@ -73046,9 +72627,9 @@ paths:
type: integer
secrets:
type: array
- items: *375
+ items: *372
examples:
- default: *376
+ default: *373
headers:
Link: *58
x-github:
@@ -73073,17 +72654,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
responses:
'200':
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73105,18 +72686,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *159
responses:
'200':
description: Response
content:
application/json:
- schema: *375
+ schema: *372
examples:
- default: *509
+ default: *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73138,9 +72719,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *159
requestBody:
required: true
@@ -73198,9 +72779,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *159
responses:
'204':
@@ -73226,10 +72807,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *330
- - *331
- - *498
- - *346
+ - *327
+ - *328
+ - *495
+ - *343
- *19
responses:
'200':
@@ -73246,9 +72827,9 @@ paths:
type: integer
variables:
type: array
- items: *379
+ items: *376
examples:
- default: *380
+ default: *377
headers:
Link: *58
x-github:
@@ -73271,9 +72852,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
requestBody:
required: true
content:
@@ -73325,18 +72906,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *330
- - *331
- - *498
+ - *327
+ - *328
+ - *495
- *162
responses:
'200':
description: Response
content:
application/json:
- schema: *379
+ schema: *376
examples:
- default: *510
+ default: *507
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73357,10 +72938,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
- - *498
+ - *495
requestBody:
required: true
content:
@@ -73402,10 +72983,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *162
- - *498
+ - *495
responses:
'204':
description: Response
@@ -73427,8 +73008,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -73496,8 +73077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -73656,8 +73237,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -73689,9 +73270,9 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
'400': *14
'422': *15
'403': *29
@@ -73712,8 +73293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -73773,7 +73354,7 @@ paths:
schema:
oneOf:
- *120
- - *511
+ - *508
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73798,8 +73379,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: file_sha
in: path
required: true
@@ -73898,8 +73479,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74008,7 +73589,7 @@ paths:
description: Response
content:
application/json:
- schema: &512
+ schema: &509
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -74222,15 +73803,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *330
- - *331
- - *465
+ - *327
+ - *328
+ - *462
responses:
'200':
description: Response
content:
application/json:
- schema: *512
+ schema: *509
examples:
default:
value:
@@ -74286,9 +73867,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *330
- - *331
- - &513
+ - *327
+ - *328
+ - &510
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.
@@ -74305,7 +73886,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &511
title: Git Reference
description: Git references within a repository
type: object
@@ -74380,17 +73961,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *330
- - *331
- - *513
+ - *327
+ - *328
+ - *510
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &515
+ default: &512
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -74419,8 +74000,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74449,9 +74030,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -74477,9 +74058,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *330
- - *331
- - *513
+ - *327
+ - *328
+ - *510
requestBody:
required: true
content:
@@ -74508,9 +74089,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
'422': *15
'409': *51
x-github:
@@ -74528,9 +74109,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *330
- - *331
- - *513
+ - *327
+ - *328
+ - *510
responses:
'204':
description: Response
@@ -74585,8 +74166,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74653,7 +74234,7 @@ paths:
description: Response
content:
application/json:
- schema: &517
+ schema: &514
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -74704,7 +74285,7 @@ paths:
- sha
- type
- url
- verification: *516
+ verification: *513
required:
- sha
- url
@@ -74714,7 +74295,7 @@ paths:
- tag
- message
examples:
- default: &518
+ default: &515
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -74787,8 +74368,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: tag_sha
in: path
required: true
@@ -74799,9 +74380,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'404': *6
'409': *51
x-github:
@@ -74825,8 +74406,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -74899,7 +74480,7 @@ paths:
description: Response
content:
application/json:
- schema: &519
+ schema: &516
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -74995,8 +74576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -75019,7 +74600,7 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
default-response:
summary: Default response
@@ -75078,8 +74659,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -75089,7 +74670,7 @@ paths:
application/json:
schema:
type: array
- items: &520
+ items: &517
title: Webhook
description: Webhooks for repositories.
type: object
@@ -75143,7 +74724,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &764
+ last_response: &759
title: Hook Response
type: object
properties:
@@ -75217,8 +74798,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -75270,9 +74851,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: &521
+ default: &518
value:
type: Repository
id: 12345678
@@ -75320,17 +74901,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'200':
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *521
+ default: *518
'404': *6
x-github:
githubCloudOnly: false
@@ -75350,8 +74931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
requestBody:
required: true
@@ -75397,9 +74978,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *521
+ default: *518
'422': *15
'404': *6
x-github:
@@ -75420,8 +75001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'204':
@@ -75446,8 +75027,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'200':
@@ -75475,8 +75056,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
requestBody:
required: false
@@ -75521,8 +75102,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
- *17
- *205
@@ -75554,8 +75135,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
- *16
responses:
@@ -75584,8 +75165,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
- *16
responses:
@@ -75609,8 +75190,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'204':
@@ -75636,8 +75217,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *204
responses:
'204':
@@ -75661,8 +75242,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response if immutable releases are enabled
@@ -75708,8 +75289,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-immutable-releases
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'409': *51
@@ -75729,8 +75310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-immutable-releases
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'409': *51
@@ -75787,14 +75368,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &522
+ schema: &519
title: Import
description: A repository import from an external source.
type: object
@@ -75893,7 +75474,7 @@ paths:
- html_url
- authors_url
examples:
- default: &525
+ default: &522
value:
vcs: subversion
use_lfs: true
@@ -75909,7 +75490,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': &523
+ '503': &520
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -75938,8 +75519,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -75987,7 +75568,7 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
default:
value:
@@ -76012,7 +75593,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76040,8 +75621,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -76090,7 +75671,7 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
example-1:
summary: Example 1
@@ -76138,7 +75719,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': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76161,12 +75742,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76192,9 +75773,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *330
- - *331
- - &697
+ - *327
+ - *328
+ - &692
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -76208,7 +75789,7 @@ paths:
application/json:
schema:
type: array
- items: &524
+ items: &521
title: Porter Author
description: Porter Author
type: object
@@ -76262,7 +75843,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': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76287,8 +75868,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: author_id
in: path
required: true
@@ -76318,7 +75899,7 @@ paths:
description: Response
content:
application/json:
- schema: *524
+ schema: *521
examples:
default:
value:
@@ -76331,7 +75912,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76355,8 +75936,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -76397,7 +75978,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76425,8 +76006,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -76453,11 +76034,11 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
- default: *525
+ default: *522
'422': *15
- '503': *523
+ '503': *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76480,8 +76061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -76489,8 +76070,8 @@ paths:
application/json:
schema: *22
examples:
- default: *526
- '301': *334
+ default: *523
+ '301': *331
'404': *6
x-github:
githubCloudOnly: false
@@ -76510,8 +76091,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -76524,7 +76105,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &528
+ default: &525
value:
limit: collaborators_only
origin: repository
@@ -76549,13 +76130,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
application/json:
- schema: *527
+ schema: *524
examples:
default:
summary: Example request body
@@ -76569,7 +76150,7 @@ paths:
application/json:
schema: *222
examples:
- default: *528
+ default: *525
'409':
description: Response
x-github:
@@ -76591,8 +76172,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -76615,8 +76196,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -76626,9 +76207,9 @@ paths:
application/json:
schema:
type: array
- items: *529
+ items: *526
examples:
- default: &690
+ default: &685
value:
- id: 1
repository:
@@ -76759,8 +76340,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *226
requestBody:
required: false
@@ -76790,7 +76371,7 @@ paths:
description: Response
content:
application/json:
- schema: *529
+ schema: *526
examples:
default:
value:
@@ -76921,8 +76502,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *226
responses:
'204':
@@ -76954,8 +76535,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *330
- - *331
+ - *327
+ - *328
- 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
@@ -77028,7 +76609,7 @@ paths:
type: array
items: *74
examples:
- default: &541
+ default: &538
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -77176,7 +76757,7 @@ paths:
state_reason: completed
headers:
Link: *58
- '301': *334
+ '301': *331
'422': *15
'404': *6
x-github:
@@ -77205,8 +76786,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -77290,7 +76871,7 @@ paths:
application/json:
schema: *74
examples:
- default: &538
+ default: &535
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -77446,7 +77027,7 @@ paths:
'422': *15
'503': *112
'404': *6
- '410': *530
+ '410': *527
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -77474,8 +77055,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *98
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -77496,9 +77077,9 @@ paths:
application/json:
schema:
type: array
- items: *531
+ items: *528
examples:
- default: &540
+ default: &537
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77556,17 +77137,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'200':
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: &532
+ default: &529
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77620,8 +77201,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -77644,9 +77225,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
'422': *15
x-github:
githubCloudOnly: false
@@ -77664,8 +77245,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'204':
@@ -77686,8 +77267,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -77714,9 +77295,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
@@ -77737,8 +77318,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -77771,16 +77352,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -77802,10 +77383,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- - *534
+ - *531
responses:
'204':
description: Response
@@ -77825,8 +77406,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -77836,7 +77417,7 @@ paths:
application/json:
schema:
type: array
- items: &537
+ items: &534
title: Issue Event
description: Issue Event
type: object
@@ -77879,8 +77460,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *535
- required: *536
+ properties: *532
+ required: *533
nullable: true
label:
title: Issue Event Label
@@ -78187,8 +77768,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: event_id
in: path
required: true
@@ -78199,7 +77780,7 @@ paths:
description: Response
content:
application/json:
- schema: *537
+ schema: *534
examples:
default:
value:
@@ -78391,7 +77972,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *530
+ '410': *527
'403': *29
x-github:
githubCloudOnly: false
@@ -78425,9 +78006,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *330
- - *331
- - &539
+ - *327
+ - *328
+ - &536
name: issue_number
description: The number that identifies the issue.
in: path
@@ -78441,10 +78022,10 @@ paths:
application/json:
schema: *74
examples:
- default: *538
- '301': *334
+ default: *535
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
'304': *37
x-github:
githubCloudOnly: false
@@ -78469,9 +78050,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -78577,13 +78158,13 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
'422': *15
'503': *112
'403': *29
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78601,9 +78182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -78631,7 +78212,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78647,9 +78228,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
content:
application/json:
@@ -78676,7 +78257,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78698,9 +78279,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:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- name: assignee
in: path
required: true
@@ -78740,9 +78321,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *81
- *17
- *19
@@ -78753,13 +78334,13 @@ paths:
application/json:
schema:
type: array
- items: *531
+ items: *528
examples:
- default: *540
+ default: *537
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78788,9 +78369,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -78812,16 +78393,16 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *530
+ '410': *527
'422': *15
'404': *6
x-github:
@@ -78849,9 +78430,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -78863,12 +78444,12 @@ paths:
type: array
items: *74
examples:
- default: *541
+ default: *538
headers:
Link: *58
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78896,9 +78477,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -78922,15 +78503,15 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *334
+ '301': *331
'403': *29
- '410': *530
+ '410': *527
'422': *15
'404': *6
x-github:
@@ -78961,9 +78542,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -78977,13 +78558,13 @@ paths:
application/json:
schema: *74
examples:
- default: *538
- '301': *334
+ default: *535
+ '301': *331
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *530
+ '410': *527
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -79009,9 +78590,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -79023,12 +78604,12 @@ paths:
type: array
items: *74
examples:
- default: *541
+ default: *538
headers:
Link: *58
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79045,9 +78626,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -79061,7 +78642,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &543
+ - &540
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -79115,7 +78696,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &544
+ - &541
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -79251,7 +78832,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &545
+ - &542
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -79302,7 +78883,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &546
+ - &543
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -79353,7 +78934,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &547
+ - &544
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -79407,7 +78988,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &548
+ - &545
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -79454,7 +79035,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &549
+ - &546
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -79501,7 +79082,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &550
+ - &547
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -79561,7 +79142,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &551
+ - &548
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -79609,7 +79190,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &552
+ - &549
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -79675,7 +79256,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &553
+ - &550
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -79741,7 +79322,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &554
+ - &551
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -79807,7 +79388,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &555
+ - &552
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -79898,7 +79479,7 @@ paths:
color: red
headers:
Link: *58
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79915,9 +79496,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -79929,7 +79510,7 @@ paths:
type: array
items: *73
examples:
- default: &542
+ default: &539
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -79947,9 +79528,9 @@ paths:
default: false
headers:
Link: *58
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79966,9 +79547,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -80029,10 +79610,10 @@ paths:
type: array
items: *73
examples:
- default: *542
- '301': *334
+ default: *539
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
'422': *15
x-github:
githubCloudOnly: false
@@ -80049,9 +79630,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -80113,10 +79694,10 @@ paths:
type: array
items: *73
examples:
- default: *542
- '301': *334
+ default: *539
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
'422': *15
x-github:
githubCloudOnly: false
@@ -80133,15 +79714,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
responses:
'204':
description: Response
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80160,9 +79741,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- name: name
in: path
required: true
@@ -80186,9 +79767,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *334
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80208,9 +79789,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: false
content:
@@ -80238,7 +79819,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *530
+ '410': *527
'404': *6
'422': *15
x-github:
@@ -80256,9 +79837,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
responses:
'204':
description: Response
@@ -80288,9 +79869,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
responses:
'200':
description: Response
@@ -80298,10 +79879,10 @@ paths:
application/json:
schema: *74
examples:
- default: *538
- '301': *334
+ default: *535
+ '301': *331
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80318,9 +79899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- 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.
@@ -80346,13 +79927,13 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80370,9 +79951,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80404,16 +79985,16 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -80435,10 +80016,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *330
- - *331
- - *539
- - *534
+ - *327
+ - *328
+ - *536
+ - *531
responses:
'204':
description: Response
@@ -80467,9 +80048,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80493,7 +80074,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -80526,9 +80107,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -80540,11 +80121,11 @@ paths:
type: array
items: *74
examples:
- default: *541
+ default: *538
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80572,9 +80153,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80603,14 +80184,14 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *530
+ '410': *527
'422': *15
'404': *6
x-github:
@@ -80630,9 +80211,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
requestBody:
required: true
content:
@@ -80665,7 +80246,7 @@ paths:
application/json:
schema: *74
examples:
- default: *538
+ default: *535
'403': *29
'404': *6
'422': *7
@@ -80687,9 +80268,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *330
- - *331
- - *539
+ - *327
+ - *328
+ - *536
- *17
- *19
responses:
@@ -80704,6 +80285,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *540
+ - *541
+ - *542
- *543
- *544
- *545
@@ -80714,9 +80298,6 @@ paths:
- *550
- *551
- *552
- - *553
- - *554
- - *555
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -81025,7 +80606,7 @@ paths:
type: string
comments:
type: array
- items: &577
+ items: &574
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -81234,7 +80815,7 @@ paths:
type: string
comments:
type: array
- items: *461
+ items: *458
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -81523,7 +81104,7 @@ paths:
headers:
Link: *58
'404': *6
- '410': *530
+ '410': *527
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81540,8 +81121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -81551,7 +81132,7 @@ paths:
application/json:
schema:
type: array
- items: &556
+ items: &553
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -81617,8 +81198,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -81654,9 +81235,9 @@ paths:
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: &557
+ default: &554
value:
id: 1
key: ssh-rsa AAA...
@@ -81690,9 +81271,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *330
- - *331
- - &558
+ - *327
+ - *328
+ - &555
name: key_id
description: The unique identifier of the key.
in: path
@@ -81704,9 +81285,9 @@ paths:
description: Response
content:
application/json:
- schema: *556
+ schema: *553
examples:
- default: *557
+ default: *554
'404': *6
x-github:
githubCloudOnly: false
@@ -81724,9 +81305,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *330
- - *331
- - *558
+ - *327
+ - *328
+ - *555
responses:
'204':
description: Response
@@ -81746,8 +81327,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -81759,7 +81340,7 @@ paths:
type: array
items: *73
examples:
- default: *542
+ default: *539
headers:
Link: *58
'404': *6
@@ -81780,8 +81361,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -81819,7 +81400,7 @@ paths:
application/json:
schema: *73
examples:
- default: &559
+ default: &556
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -81851,8 +81432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: name
in: path
required: true
@@ -81865,7 +81446,7 @@ paths:
application/json:
schema: *73
examples:
- default: *559
+ default: *556
'404': *6
x-github:
githubCloudOnly: false
@@ -81882,8 +81463,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: name
in: path
required: true
@@ -81948,8 +81529,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: name
in: path
required: true
@@ -81975,8 +81556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -82015,9 +81596,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *330
- - *331
- - *434
+ - *327
+ - *328
+ - *431
responses:
'200':
description: Response
@@ -82162,8 +81743,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82228,8 +81809,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82263,9 +81844,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *560
+ default: *557
'204':
description: Response when already merged
'404':
@@ -82290,8 +81871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -82332,7 +81913,7 @@ paths:
application/json:
schema:
type: array
- items: &561
+ items: &558
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -82393,8 +81974,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82434,9 +82015,9 @@ paths:
description: Response
content:
application/json:
- schema: *561
+ schema: *558
examples:
- default: &562
+ default: &559
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -82495,9 +82076,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *330
- - *331
- - &563
+ - *327
+ - *328
+ - &560
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -82509,9 +82090,9 @@ paths:
description: Response
content:
application/json:
- schema: *561
+ schema: *558
examples:
- default: *562
+ default: *559
'404': *6
x-github:
githubCloudOnly: false
@@ -82528,9 +82109,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *330
- - *331
- - *563
+ - *327
+ - *328
+ - *560
requestBody:
required: false
content:
@@ -82568,9 +82149,9 @@ paths:
description: Response
content:
application/json:
- schema: *561
+ schema: *558
examples:
- default: *562
+ default: *559
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82586,9 +82167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *330
- - *331
- - *563
+ - *327
+ - *328
+ - *560
responses:
'204':
description: Response
@@ -82609,9 +82190,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *330
- - *331
- - *563
+ - *327
+ - *328
+ - *560
- *17
- *19
responses:
@@ -82623,7 +82204,7 @@ paths:
type: array
items: *73
examples:
- default: *542
+ default: *539
headers:
Link: *58
x-github:
@@ -82642,12 +82223,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *330
- - *331
- - *564
- - *565
+ - *327
+ - *328
+ - *561
+ - *562
- *81
- - *566
+ - *563
- *17
- *19
responses:
@@ -82659,7 +82240,7 @@ paths:
type: array
items: *101
examples:
- default: *567
+ default: *564
headers:
Link: *58
x-github:
@@ -82683,8 +82264,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -82742,14 +82323,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: &568
+ schema: &565
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -82874,7 +82455,7 @@ paths:
- custom_404
- public
examples:
- default: &569
+ default: &566
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -82915,8 +82496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -82970,9 +82551,9 @@ paths:
description: Response
content:
application/json:
- schema: *568
+ schema: *565
examples:
- default: *569
+ default: *566
'422': *15
'409': *51
x-github:
@@ -82995,8 +82576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -83095,8 +82676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -83122,8 +82703,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -83133,7 +82714,7 @@ paths:
application/json:
schema:
type: array
- items: &570
+ items: &567
title: Page Build
description: Page Build
type: object
@@ -83227,8 +82808,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'201':
description: Response
@@ -83273,16 +82854,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *570
+ schema: *567
examples:
- default: &571
+ default: &568
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -83330,8 +82911,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: build_id
in: path
required: true
@@ -83342,9 +82923,9 @@ paths:
description: Response
content:
application/json:
- schema: *570
+ schema: *567
examples:
- default: *571
+ default: *568
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -83364,8 +82945,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -83470,9 +83051,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *330
- - *331
- - &572
+ - *327
+ - *328
+ - &569
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -83530,9 +83111,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *330
- - *331
- - *572
+ - *327
+ - *328
+ - *569
responses:
'204': *183
'404': *6
@@ -83559,8 +83140,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -83818,8 +83399,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Private vulnerability reporting status
@@ -83856,8 +83437,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'422': *14
@@ -83878,8 +83459,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204': *183
'422': *14
@@ -83901,8 +83482,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -83912,7 +83493,7 @@ paths:
type: array
items: *110
examples:
- default: *573
+ default: *570
'403': *29
'404': *6
x-github:
@@ -83934,8 +83515,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -83951,7 +83532,7 @@ paths:
required:
- properties
examples:
- default: *574
+ default: *571
responses:
'204':
description: No Content when custom property values are successfully created
@@ -83989,8 +83570,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -84050,9 +83631,9 @@ paths:
application/json:
schema:
type: array
- items: *468
+ items: *465
examples:
- default: *575
+ default: *572
headers:
Link: *58
'304': *37
@@ -84084,8 +83665,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -84150,7 +83731,7 @@ paths:
description: Response
content:
application/json:
- schema: &579
+ schema: &576
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -84364,7 +83945,7 @@ paths:
- review_comment
- self
author_association: *75
- auto_merge: *576
+ auto_merge: *573
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -84456,7 +84037,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &580
+ default: &577
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -84983,8 +84564,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sort
in: query
required: false
@@ -85013,9 +84594,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: &582
+ default: &579
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -85092,17 +84673,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'200':
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: &578
+ default: &575
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -85177,8 +84758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -85201,9 +84782,9 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85219,8 +84800,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
responses:
'204':
@@ -85242,8 +84823,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -85270,9 +84851,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
@@ -85293,8 +84874,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
requestBody:
required: true
@@ -85327,16 +84908,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -85358,10 +84939,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *90
- - *534
+ - *531
responses:
'204':
description: Response
@@ -85404,9 +84985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *330
- - *331
- - &581
+ - *327
+ - *328
+ - &578
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -85419,9 +85000,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
'304': *37
'404': *6
'406':
@@ -85456,9 +85037,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -85500,9 +85081,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
'422': *15
'403': *29
x-github:
@@ -85524,9 +85105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: true
content:
@@ -85588,7 +85169,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -85596,7 +85177,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'401': *25
'403': *29
'404': *6
@@ -85626,9 +85207,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *98
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -85649,9 +85230,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *582
+ default: *579
headers:
Link: *58
x-github:
@@ -85684,9 +85265,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: true
content:
@@ -85791,7 +85372,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
example-for-a-multi-line-comment:
value:
@@ -85879,9 +85460,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *90
requestBody:
required: true
@@ -85904,7 +85485,7 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
default:
value:
@@ -85990,9 +85571,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *17
- *19
responses:
@@ -86002,9 +85583,9 @@ paths:
application/json:
schema:
type: array
- items: *464
+ items: *461
examples:
- default: *583
+ default: *580
headers:
Link: *58
x-github:
@@ -86034,9 +85615,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *17
- *19
responses:
@@ -86046,7 +85627,7 @@ paths:
application/json:
schema:
type: array
- items: *477
+ items: *474
examples:
default:
value:
@@ -86084,9 +85665,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
responses:
'204':
description: Response if pull request has been merged
@@ -86109,9 +85690,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -86222,9 +85803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
responses:
'200':
description: Response
@@ -86299,9 +85880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -86338,7 +85919,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -86874,9 +86455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: true
content:
@@ -86910,7 +86491,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -87415,9 +86996,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
- *17
- *19
responses:
@@ -87427,7 +87008,7 @@ paths:
application/json:
schema:
type: array
- items: &584
+ items: &581
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -87578,9 +87159,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -87666,9 +87247,9 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: &586
+ default: &583
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87731,10 +87312,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - &585
+ - *327
+ - *328
+ - *578
+ - &582
name: review_id
description: The unique identifier of the review.
in: path
@@ -87746,9 +87327,9 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: &587
+ default: &584
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87807,10 +87388,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
requestBody:
required: true
content:
@@ -87833,7 +87414,7 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
default:
value:
@@ -87895,18 +87476,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
responses:
'200':
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: *586
+ default: *583
'422': *7
'404': *6
x-github:
@@ -87933,10 +87514,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
- *17
- *19
responses:
@@ -88171,10 +87752,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
requestBody:
required: true
content:
@@ -88202,7 +87783,7 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
default:
value:
@@ -88265,10 +87846,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *330
- - *331
- - *581
- - *585
+ - *327
+ - *328
+ - *578
+ - *582
requestBody:
required: true
content:
@@ -88303,9 +87884,9 @@ paths:
description: Response
content:
application/json:
- schema: *584
+ schema: *581
examples:
- default: *587
+ default: *584
'404': *6
'422': *7
'403': *29
@@ -88327,9 +87908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *330
- - *331
- - *581
+ - *327
+ - *328
+ - *578
requestBody:
required: false
content:
@@ -88392,8 +87973,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -88406,9 +87987,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: &589
+ default: &586
value:
type: file
encoding: base64
@@ -88450,8 +88031,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: dir
description: The alternate path to look for a README file
in: path
@@ -88471,9 +88052,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: *589
+ default: *586
'404': *6
'422': *15
x-github:
@@ -88495,8 +88076,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -88506,7 +88087,7 @@ paths:
application/json:
schema:
type: array
- items: *590
+ items: *587
examples:
default:
value:
@@ -88600,8 +88181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -88677,9 +88258,9 @@ paths:
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: &594
+ default: &591
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -88784,9 +88365,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *330
- - *331
- - &592
+ - *327
+ - *328
+ - &589
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -88798,9 +88379,9 @@ paths:
description: Response
content:
application/json:
- schema: *591
+ schema: *588
examples:
- default: &593
+ default: &590
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
@@ -88835,7 +88416,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *479
+ '302': *476
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88851,9 +88432,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *330
- - *331
- - *592
+ - *327
+ - *328
+ - *589
requestBody:
required: false
content:
@@ -88881,9 +88462,9 @@ paths:
description: Response
content:
application/json:
- schema: *591
+ schema: *588
examples:
- default: *593
+ default: *590
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88899,9 +88480,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *330
- - *331
- - *592
+ - *327
+ - *328
+ - *589
responses:
'204':
description: Response
@@ -88925,8 +88506,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -89011,16 +88592,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: *594
+ default: *591
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89037,8 +88618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: tag
description: tag parameter
in: path
@@ -89051,9 +88632,9 @@ paths:
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: *594
+ default: *591
'404': *6
x-github:
githubCloudOnly: false
@@ -89075,9 +88656,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *330
- - *331
- - &595
+ - *327
+ - *328
+ - &592
name: release_id
description: The unique identifier of the release.
in: path
@@ -89091,9 +88672,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: *590
+ schema: *587
examples:
- default: *594
+ default: *591
'401':
description: Unauthorized
x-github:
@@ -89111,9 +88692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
requestBody:
required: false
content:
@@ -89177,9 +88758,9 @@ paths:
description: Response
content:
application/json:
- schema: *590
+ schema: *587
examples:
- default: *594
+ default: *591
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -89200,9 +88781,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
responses:
'204':
description: Response
@@ -89222,9 +88803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
- *17
- *19
responses:
@@ -89234,7 +88815,7 @@ paths:
application/json:
schema:
type: array
- items: *591
+ items: *588
examples:
default:
value:
@@ -89315,9 +88896,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:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
- name: name
in: query
required: true
@@ -89343,7 +88924,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *591
+ schema: *588
examples:
response-for-successful-upload:
value:
@@ -89398,9 +88979,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
- 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.
@@ -89424,9 +89005,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *533
+ default: *530
headers:
Link: *58
'404': *6
@@ -89447,9 +89028,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *330
- - *331
- - *595
+ - *327
+ - *328
+ - *592
requestBody:
required: true
content:
@@ -89479,16 +89060,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'201':
description: Reaction created
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *15
x-github:
githubCloudOnly: false
@@ -89510,10 +89091,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *330
- - *331
- - *595
- - *534
+ - *327
+ - *328
+ - *592
+ - *531
responses:
'204':
description: Response
@@ -89537,9 +89118,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *330
- - *331
- - *397
+ - *327
+ - *328
+ - *394
- *17
- *19
responses:
@@ -89556,7 +89137,7 @@ paths:
oneOf:
- allOf:
- *286
- - &596
+ - &593
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -89577,67 +89158,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *287
- - *596
+ - *593
- allOf:
- *288
- - *596
+ - *593
- allOf:
- *289
- - *596
+ - *593
- allOf:
- - *597
- - *596
+ - *594
+ - *593
- allOf:
- *290
- - *596
+ - *593
- allOf:
- *291
- - *596
+ - *593
- allOf:
- *292
- - *596
+ - *593
- allOf:
- *293
- - *596
+ - *593
- allOf:
- *294
- - *596
+ - *593
- allOf:
- *295
- - *596
+ - *593
- allOf:
- *296
- - *596
+ - *593
- allOf:
- *297
- - *596
+ - *593
- allOf:
- *298
- - *596
+ - *593
- allOf:
- *299
- - *596
+ - *593
- allOf:
- *300
- - *596
+ - *593
- allOf:
- *301
- - *596
+ - *593
- allOf:
- *302
- - *596
+ - *593
- allOf:
- *303
- - *596
+ - *593
- allOf:
- *304
- - *596
+ - *593
- allOf:
- *305
- - *596
+ - *593
- allOf:
- *306
- - *596
+ - *593
examples:
default:
value:
@@ -89676,8 +89257,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- name: includes_parents
@@ -89688,7 +89269,7 @@ paths:
schema:
type: boolean
default: true
- - *598
+ - *595
responses:
'200':
description: Response
@@ -89743,8 +89324,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
description: Request body
required: true
@@ -89773,7 +89354,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *599
+ items: *596
required:
- name
- enforcement
@@ -89806,7 +89387,7 @@ paths:
application/json:
schema: *307
examples:
- default: &609
+ default: &606
value:
id: 42
name: super cool ruleset
@@ -89853,12 +89434,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *330
- - *331
+ - *327
+ - *328
+ - *597
+ - *598
+ - *599
- *600
- - *601
- - *602
- - *603
- *17
- *19
responses:
@@ -89866,9 +89447,9 @@ paths:
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
'404': *6
'500': *111
x-github:
@@ -89889,17 +89470,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *330
- - *331
- - *606
+ - *327
+ - *328
+ - *603
responses:
'200':
description: Response
content:
application/json:
- schema: *607
+ schema: *604
examples:
- default: *608
+ default: *605
'404': *6
'500': *111
x-github:
@@ -89927,8 +89508,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89950,7 +89531,7 @@ paths:
application/json:
schema: *307
examples:
- default: *609
+ default: *606
'404': *6
'500': *111
put:
@@ -89968,8 +89549,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -90003,7 +89584,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *599
+ items: *596
examples:
default:
value:
@@ -90033,7 +89614,7 @@ paths:
application/json:
schema: *307
examples:
- default: *609
+ default: *606
'404': *6
'500': *111
delete:
@@ -90051,8 +89632,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -90075,8 +89656,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
- name: ruleset_id
@@ -90094,7 +89675,7 @@ paths:
type: array
items: *310
examples:
- default: *610
+ default: *607
'404': *6
'500': *111
x-github:
@@ -90113,8 +89694,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -90132,7 +89713,7 @@ paths:
description: Response
content:
application/json:
- schema: *611
+ schema: *608
examples:
default:
value:
@@ -90187,22 +89768,22 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
+ - *609
+ - *610
+ - *611
- *612
- *613
- - *614
- - *615
- - *616
- *52
- *19
- *17
+ - *614
+ - *615
+ - *616
- *617
- *618
- *619
- - *620
- - *621
- - *622
responses:
'200':
description: Response
@@ -90210,7 +89791,7 @@ paths:
application/json:
schema:
type: array
- items: &626
+ items: &623
type: object
properties:
number: *169
@@ -90229,8 +89810,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *623
- resolution: *624
+ state: *620
+ resolution: *621
resolved_at:
type: string
format: date-time
@@ -90326,7 +89907,7 @@ paths:
pull request.
'
- oneOf: *625
+ oneOf: *622
nullable: true
has_more_locations:
type: boolean
@@ -90475,16 +90056,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *330
- - *331
- - *428
- - *622
+ - *327
+ - *328
+ - *425
+ - *619
responses:
'200':
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -90538,9 +90119,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
requestBody:
required: true
content:
@@ -90548,8 +90129,8 @@ paths:
schema:
type: object
properties:
- state: *623
- resolution: *624
+ state: *620
+ resolution: *621
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -90583,7 +90164,7 @@ paths:
description: Response
content:
application/json:
- schema: *626
+ schema: *623
examples:
default:
value:
@@ -90678,9 +90259,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *330
- - *331
- - *428
+ - *327
+ - *328
+ - *425
- *19
- *17
responses:
@@ -90691,7 +90272,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &786
+ items: &781
type: object
properties:
type:
@@ -90717,6 +90298,9 @@ paths:
example: commit
details:
oneOf:
+ - *624
+ - *625
+ - *626
- *627
- *628
- *629
@@ -90727,9 +90311,6 @@ paths:
- *634
- *635
- *636
- - *637
- - *638
- - *639
examples:
default:
value:
@@ -90815,8 +90396,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -90824,14 +90405,14 @@ paths:
schema:
type: object
properties:
- reason: &641
+ reason: &638
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *640
+ placeholder_id: *637
required:
- reason
- placeholder_id
@@ -90848,7 +90429,7 @@ paths:
schema:
type: object
properties:
- reason: *641
+ reason: *638
expire_at:
type: string
format: date-time
@@ -90894,8 +90475,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -90910,7 +90491,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &642
+ items: &639
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -90936,15 +90517,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *642
+ items: *639
backfill_scans:
type: array
- items: *642
+ items: *639
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *642
+ - *639
- type: object
properties:
pattern_name:
@@ -91014,8 +90595,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *52
- name: sort
description: The property to sort the results by.
@@ -91059,9 +90640,9 @@ paths:
application/json:
schema:
type: array
- items: *643
+ items: *640
examples:
- default: *644
+ default: *641
'400': *14
'404': *6
x-github:
@@ -91084,8 +90665,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -91245,9 +90826,9 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
- default: &646
+ default: &643
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -91480,8 +91061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -91585,7 +91166,7 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
default:
value:
@@ -91732,17 +91313,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
responses:
'200':
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
- default: *646
+ default: *643
'403': *29
'404': *6
x-github:
@@ -91766,9 +91347,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
requestBody:
required: true
content:
@@ -91927,10 +91508,10 @@ paths:
description: Response
content:
application/json:
- schema: *643
+ schema: *640
examples:
- default: *646
- add_credit: *646
+ default: *643
+ add_credit: *643
'403': *29
'404': *6
'422':
@@ -91968,9 +91549,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:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
responses:
'202': *39
'400': *14
@@ -91997,17 +91578,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *330
- - *331
- - *645
+ - *327
+ - *328
+ - *642
responses:
'202':
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
'400': *14
'422': *15
'403': *29
@@ -92033,8 +91614,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -92133,8 +91714,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -92143,7 +91724,7 @@ paths:
application/json:
schema:
type: array
- items: &647
+ items: &644
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -92176,8 +91757,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -92253,8 +91834,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -92350,8 +91931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -92505,8 +92086,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -92516,7 +92097,7 @@ paths:
application/json:
schema:
type: array
- items: *647
+ items: *644
examples:
default:
value:
@@ -92549,8 +92130,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: sha
in: path
required: true
@@ -92604,7 +92185,7 @@ paths:
description: Response
content:
application/json:
- schema: *648
+ schema: *645
examples:
default:
value:
@@ -92658,8 +92239,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -92691,14 +92272,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &649
+ schema: &646
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -92766,8 +92347,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -92793,7 +92374,7 @@ paths:
description: Response
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
value:
@@ -92820,8 +92401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -92841,8 +92422,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -92921,8 +92502,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -92930,7 +92511,7 @@ paths:
application/json:
schema:
type: array
- items: &650
+ items: &647
title: Tag protection
description: Tag protection
type: object
@@ -92982,8 +92563,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:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -93006,7 +92587,7 @@ paths:
description: Response
content:
application/json:
- schema: *650
+ schema: *647
examples:
default:
value:
@@ -93037,8 +92618,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:
- - *330
- - *331
+ - *327
+ - *328
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -93075,8 +92656,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
in: path
required: true
@@ -93112,8 +92693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *17
- *19
responses:
@@ -93145,8 +92726,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *330
- - *331
+ - *327
+ - *328
- *19
- *17
responses:
@@ -93154,7 +92735,7 @@ paths:
description: Response
content:
application/json:
- schema: &651
+ schema: &648
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -93166,7 +92747,7 @@ paths:
required:
- names
examples:
- default: &652
+ default: &649
value:
names:
- octocat
@@ -93189,8 +92770,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -93221,9 +92802,9 @@ paths:
description: Response
content:
application/json:
- schema: *651
+ schema: *648
examples:
- default: *652
+ default: *649
'404': *6
'422': *7
x-github:
@@ -93244,9 +92825,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *330
- - *331
- - &653
+ - *327
+ - *328
+ - &650
name: per
description: The time frame to display results for.
in: query
@@ -93275,7 +92856,7 @@ paths:
example: 128
clones:
type: array
- items: &654
+ items: &651
title: Traffic
type: object
properties:
@@ -93363,8 +92944,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -93455,8 +93036,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'200':
description: Response
@@ -93517,9 +93098,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *330
- - *331
- - *653
+ - *327
+ - *328
+ - *650
responses:
'200':
description: Response
@@ -93538,7 +93119,7 @@ paths:
example: 3782
views:
type: array
- items: *654
+ items: *651
required:
- uniques
- count
@@ -93616,8 +93197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
requestBody:
required: true
content:
@@ -93891,8 +93472,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -93915,8 +93496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -93938,8 +93519,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -93965,8 +93546,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *330
- - *331
+ - *327
+ - *328
- name: ref
in: path
required: true
@@ -94058,9 +93639,9 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -94308,7 +93889,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &655
+ text_matches: &652
title: Search Result Text Matches
type: array
items:
@@ -94470,7 +94051,7 @@ paths:
enum:
- author-date
- committer-date
- - &656
+ - &653
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
@@ -94541,7 +94122,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *395
+ properties: *392
nullable: true
comment_count:
type: integer
@@ -94561,7 +94142,7 @@ paths:
url:
type: string
format: uri
- verification: *516
+ verification: *513
required:
- author
- committer
@@ -94580,7 +94161,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *395
+ properties: *392
nullable: true
parents:
type: array
@@ -94598,7 +94179,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *655
+ text_matches: *652
required:
- sha
- node_id
@@ -94790,7 +94371,7 @@ paths:
- interactions
- created
- updated
- - *656
+ - *653
- *17
- *19
- name: advanced_search
@@ -94887,11 +94468,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
type: string
state_reason:
@@ -94923,7 +94504,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *655
+ text_matches: *652
pull_request:
type: object
properties:
@@ -95148,7 +94729,7 @@ paths:
enum:
- created
- updated
- - *656
+ - *653
- *17
- *19
responses:
@@ -95192,7 +94773,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *655
+ text_matches: *652
required:
- id
- node_id
@@ -95277,7 +94858,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *656
+ - *653
- *17
- *19
responses:
@@ -95516,7 +95097,7 @@ paths:
- admin
- pull
- push
- text_matches: *655
+ text_matches: *652
temp_clone_token:
type: string
allow_merge_commit:
@@ -95816,7 +95397,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *655
+ text_matches: *652
related:
type: array
nullable: true
@@ -96007,7 +95588,7 @@ paths:
- followers
- repositories
- joined
- - *656
+ - *653
- *17
- *19
responses:
@@ -96111,7 +95692,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *655
+ text_matches: *652
blog:
type: string
nullable: true
@@ -96190,7 +95771,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &660
+ - &657
name: team_id
description: The unique identifier of the team.
in: path
@@ -96231,7 +95812,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *660
+ - *657
requestBody:
required: true
content:
@@ -96331,7 +95912,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *660
+ - *657
responses:
'204':
description: Response
@@ -96362,7 +95943,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
parameters:
- - *660
+ - *657
- *52
- *17
- *19
@@ -96375,7 +95956,7 @@ paths:
type: array
items: *323
examples:
- default: *661
+ default: *658
headers:
Link: *58
x-github:
@@ -96404,7 +95985,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *660
+ - *657
requestBody:
required: true
content:
@@ -96467,7 +96048,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *660
+ - *657
- *325
responses:
'200':
@@ -96501,7 +96082,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *660
+ - *657
- *325
requestBody:
required: false
@@ -96527,7 +96108,7 @@ paths:
application/json:
schema: *323
examples:
- default: *662
+ default: *659
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96552,7 +96133,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *660
+ - *657
- *325
responses:
'204':
@@ -96565,218 +96146,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - *660
- - *325
- - *52
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *326
- examples:
- default: *663
- headers:
- Link: *58
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *327
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- - *328
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *327
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- - *328
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *326
- examples:
- default: *664
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - *660
- - *325
- - *328
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -96792,7 +96161,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *660
+ - *657
- *17
- *19
responses:
@@ -96830,7 +96199,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *660
+ - *657
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -96881,7 +96250,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -96918,7 +96287,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -96958,7 +96327,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -96995,16 +96364,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'200':
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- response-if-user-is-a-team-maintainer: *665
+ response-if-user-is-a-team-maintainer: *660
'404': *6
x-github:
githubCloudOnly: false
@@ -97037,7 +96406,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *660
+ - *657
- *63
requestBody:
required: false
@@ -97063,9 +96432,9 @@ paths:
description: Response
content:
application/json:
- schema: *329
+ schema: *326
examples:
- response-if-users-membership-with-team-is-now-pending: *666
+ response-if-users-membership-with-team-is-now-pending: *661
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -97099,7 +96468,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *660
+ - *657
- *63
responses:
'204':
@@ -97127,7 +96496,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *660
+ - *657
- *17
- *19
responses:
@@ -97169,15 +96538,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *660
- - *330
- - *331
+ - *657
+ - *327
+ - *328
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *667
+ schema: *662
examples:
alternative-response-with-extra-repository-information:
value:
@@ -97328,9 +96697,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *660
- - *330
- - *331
+ - *657
+ - *327
+ - *328
requestBody:
required: false
content:
@@ -97380,9 +96749,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *660
- - *330
- - *331
+ - *657
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -97407,7 +96776,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *660
+ - *657
- *17
- *19
responses:
@@ -97419,7 +96788,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: *668
+ response-if-child-teams-exist: *663
headers:
Link: *58
'404': *6
@@ -97452,7 +96821,7 @@ paths:
application/json:
schema:
oneOf:
- - &670
+ - &665
title: Private User
description: Private User
type: object
@@ -97655,7 +97024,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *669
+ - *664
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -97808,7 +97177,7 @@ paths:
description: Response
content:
application/json:
- schema: *670
+ schema: *665
examples:
default:
value:
@@ -98154,7 +97523,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -98162,7 +97531,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'401': *25
'403': *29
'404': *6
@@ -98206,7 +97575,7 @@ paths:
type: integer
secrets:
type: array
- items: &671
+ items: &666
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -98246,7 +97615,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *454
+ default: *451
headers:
Link: *58
x-github:
@@ -98322,7 +97691,7 @@ paths:
description: Response
content:
application/json:
- schema: *671
+ schema: *666
examples:
default:
value:
@@ -98468,7 +97837,7 @@ paths:
type: array
items: *151
examples:
- default: *672
+ default: *667
'401': *25
'403': *29
'404': *6
@@ -98620,7 +97989,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'304': *37
'500': *111
'401': *25
@@ -98678,7 +98047,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'401': *25
'403': *29
'404': *6
@@ -98735,7 +98104,7 @@ paths:
description: Response
content:
application/json:
- schema: &673
+ schema: &668
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -98776,7 +98145,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &674
+ default: &669
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -98821,9 +98190,9 @@ paths:
description: Response
content:
application/json:
- schema: *673
+ schema: *668
examples:
- default: *674
+ default: *669
'404': *6
x-github:
githubCloudOnly: false
@@ -98860,9 +98229,9 @@ paths:
type: integer
machines:
type: array
- items: *675
+ items: *670
examples:
- default: *676
+ default: *671
'304': *37
'500': *111
'401': *25
@@ -98941,13 +98310,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *333
+ repository: *330
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *452
- required: *453
+ properties: *449
+ required: *450
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -99729,7 +99098,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'304': *37
'500': *111
'400': *14
@@ -99769,7 +99138,7 @@ paths:
application/json:
schema: *232
examples:
- default: *451
+ default: *448
'500': *111
'401': *25
'403': *29
@@ -99801,7 +99170,7 @@ paths:
type: array
items: *245
examples:
- default: &687
+ default: &682
value:
- id: 197
name: hello_docker
@@ -99902,7 +99271,7 @@ paths:
application/json:
schema:
type: array
- items: &677
+ items: &672
title: Email
description: Email
type: object
@@ -99967,9 +99336,9 @@ paths:
application/json:
schema:
type: array
- items: *677
+ items: *672
examples:
- default: &689
+ default: &684
value:
- email: octocat@github.com
verified: true
@@ -100044,7 +99413,7 @@ paths:
application/json:
schema:
type: array
- items: *677
+ items: *672
examples:
default:
value:
@@ -100300,7 +99669,7 @@ paths:
application/json:
schema:
type: array
- items: &678
+ items: &673
title: GPG Key
description: A unique encryption key
type: object
@@ -100431,7 +99800,7 @@ paths:
- subkeys
- revoked
examples:
- default: &703
+ default: &698
value:
- id: 3
name: Octocat's GPG Key
@@ -100516,9 +99885,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *673
examples:
- default: &679
+ default: &674
value:
id: 3
name: Octocat's GPG Key
@@ -100575,7 +99944,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &680
+ - &675
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -100587,9 +99956,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *673
examples:
- default: *679
+ default: *674
'404': *6
'304': *37
'403': *29
@@ -100612,7 +99981,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *680
+ - *675
responses:
'204':
description: Response
@@ -100917,7 +100286,7 @@ paths:
required: true
content:
application/json:
- schema: *527
+ schema: *524
examples:
default:
value:
@@ -101067,7 +100436,7 @@ paths:
application/json:
schema:
type: array
- items: &681
+ items: &676
title: Key
description: Key
type: object
@@ -101168,9 +100537,9 @@ paths:
description: Response
content:
application/json:
- schema: *681
+ schema: *676
examples:
- default: &682
+ default: &677
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -101203,15 +100572,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *558
+ - *555
responses:
'200':
description: Response
content:
application/json:
- schema: *681
+ schema: *676
examples:
- default: *682
+ default: *677
'404': *6
'304': *37
'403': *29
@@ -101234,7 +100603,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *558
+ - *555
responses:
'204':
description: Response
@@ -101267,7 +100636,7 @@ paths:
application/json:
schema:
type: array
- items: &683
+ items: &678
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -101335,7 +100704,7 @@ paths:
- account
- plan
examples:
- default: &684
+ default: &679
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -101397,9 +100766,9 @@ paths:
application/json:
schema:
type: array
- items: *683
+ items: *678
examples:
- default: *684
+ default: *679
headers:
Link: *58
'304': *37
@@ -102408,7 +101777,7 @@ paths:
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- *239
- - *685
+ - *680
responses:
'204':
description: Response
@@ -102523,7 +101892,7 @@ paths:
- docker
- nuget
- container
- - *686
+ - *681
- *19
- *17
responses:
@@ -102535,8 +101904,8 @@ paths:
type: array
items: *245
examples:
- default: *687
- '400': *688
+ default: *682
+ '400': *683
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -102565,7 +101934,7 @@ paths:
application/json:
schema: *245
examples:
- default: &704
+ default: &699
value:
id: 40201
name: octo-name
@@ -102927,9 +102296,9 @@ paths:
application/json:
schema:
type: array
- items: *677
+ items: *672
examples:
- default: *689
+ default: *684
headers:
Link: *58
'304': *37
@@ -103042,7 +102411,7 @@ paths:
type: array
items: *70
examples:
- default: &696
+ default: &691
summary: Default response
value:
- id: 1296269
@@ -103346,9 +102715,9 @@ paths:
description: Response
content:
application/json:
- schema: *333
+ schema: *330
examples:
- default: *335
+ default: *332
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -103386,9 +102755,9 @@ paths:
application/json:
schema:
type: array
- items: *529
+ items: *526
examples:
- default: *690
+ default: *685
headers:
Link: *58
'304': *37
@@ -103467,7 +102836,7 @@ paths:
application/json:
schema:
type: array
- items: &691
+ items: &686
title: Social account
description: Social media account
type: object
@@ -103482,7 +102851,7 @@ paths:
- provider
- url
examples:
- default: &692
+ default: &687
value:
- provider: twitter
url: https://twitter.com/github
@@ -103544,9 +102913,9 @@ paths:
application/json:
schema:
type: array
- items: *691
+ items: *686
examples:
- default: *692
+ default: *687
'422': *15
'304': *37
'404': *6
@@ -103633,7 +103002,7 @@ paths:
application/json:
schema:
type: array
- items: &693
+ items: &688
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -103653,7 +103022,7 @@ paths:
- title
- created_at
examples:
- default: &722
+ default: &717
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103717,9 +103086,9 @@ paths:
description: Response
content:
application/json:
- schema: *693
+ schema: *688
examples:
- default: &694
+ default: &689
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103749,7 +103118,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:
- - &695
+ - &690
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -103761,9 +103130,9 @@ paths:
description: Response
content:
application/json:
- schema: *693
+ schema: *688
examples:
- default: *694
+ default: *689
'404': *6
'304': *37
'403': *29
@@ -103786,7 +103155,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:
- - *695
+ - *690
responses:
'204':
description: Response
@@ -103815,7 +103184,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &723
+ - &718
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
@@ -103840,11 +103209,11 @@ paths:
type: array
items: *70
examples:
- default-response: *696
+ default-response: *691
application/vnd.github.v3.star+json:
schema:
type: array
- items: &724
+ items: &719
title: Starred Repository
description: Starred Repository
type: object
@@ -104000,8 +103369,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:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response if this repository is starred by you
@@ -104029,8 +103398,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -104054,8 +103423,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *330
- - *331
+ - *327
+ - *328
responses:
'204':
description: Response
@@ -104213,10 +103582,10 @@ paths:
application/json:
schema:
oneOf:
- - *670
- - *669
+ - *665
+ - *664
examples:
- default-response: &698
+ default-response: &693
summary: Default response
value:
login: octocat
@@ -104251,7 +103620,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &699
+ response-with-git-hub-plan-information: &694
summary: Response with GitHub plan information
value:
login: octocat
@@ -104373,7 +103742,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *697
+ - *692
- *17
responses:
'200':
@@ -104422,11 +103791,11 @@ paths:
application/json:
schema:
oneOf:
- - *670
- - *669
+ - *665
+ - *664
examples:
- default-response: *698
- response-with-git-hub-plan-information: *699
+ default-response: *693
+ response-with-git-hub-plan-information: *694
'404': *6
x-github:
githubCloudOnly: false
@@ -104476,8 +103845,8 @@ paths:
required:
- subject_digests
examples:
- default: *700
- withPredicateType: *701
+ default: *695
+ withPredicateType: *696
responses:
'200':
description: Response
@@ -104530,7 +103899,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *702
+ default: *697
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104735,7 +104104,7 @@ paths:
initiator:
type: string
examples:
- default: *391
+ default: *388
'201':
description: Response
content:
@@ -104776,7 +104145,7 @@ paths:
type: array
items: *245
examples:
- default: *687
+ default: *682
'403': *29
'401': *25
x-github:
@@ -105160,9 +104529,9 @@ paths:
application/json:
schema:
type: array
- items: *678
+ items: *673
examples:
- default: *703
+ default: *698
headers:
Link: *58
x-github:
@@ -105266,7 +104635,7 @@ paths:
application/json:
schema: *22
examples:
- default: *526
+ default: *523
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105390,7 +104759,7 @@ paths:
- docker
- nuget
- container
- - *686
+ - *681
- *63
- *19
- *17
@@ -105403,10 +104772,10 @@ paths:
type: array
items: *245
examples:
- default: *687
+ default: *682
'403': *29
'401': *25
- '400': *688
+ '400': *683
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105436,7 +104805,7 @@ paths:
application/json:
schema: *245
examples:
- default: *704
+ default: *699
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105785,7 +105154,7 @@ paths:
type: array
items: *267
examples:
- default: *705
+ default: *700
headers:
Link: *58
'304': *37
@@ -105845,7 +105214,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *706
+ items: *701
required:
- name
- data_type
@@ -105861,7 +105230,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *707
+ iteration_configuration: *702
required:
- name
- data_type
@@ -105883,8 +105252,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *708
- iteration_field: *709
+ single_select_field: *703
+ iteration_field: *704
responses:
'201':
description: Response
@@ -105892,11 +105261,11 @@ paths:
application/json:
schema: *267
examples:
- text_field: *710
- number_field: *711
- date_field: *712
- single_select_field: *713
- iteration_field: *714
+ text_field: *705
+ number_field: *706
+ date_field: *707
+ single_select_field: *708
+ iteration_field: *709
'304': *37
'403': *29
'401': *25
@@ -105918,7 +105287,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-user
parameters:
- *263
- - *715
+ - *710
- *63
responses:
'200':
@@ -105927,7 +105296,7 @@ paths:
application/json:
schema: *267
examples:
- default: *716
+ default: *711
headers:
Link: *58
'304': *37
@@ -106277,7 +105646,7 @@ paths:
parameters:
- *263
- *63
- - *717
+ - *712
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -106552,7 +105921,7 @@ paths:
- *114
- *116
- *115
- - *718
+ - *713
- *117
responses:
'200':
@@ -106683,7 +106052,7 @@ paths:
parameters:
- *63
- *114
- - *719
+ - *714
- *115
responses:
'200':
@@ -106782,9 +106151,9 @@ paths:
- *114
- *116
- *115
- - *720
+ - *715
- *117
- - *721
+ - *716
responses:
'200':
description: Response when getting a billing usage summary
@@ -106918,9 +106287,9 @@ paths:
application/json:
schema:
type: array
- items: *691
+ items: *686
examples:
- default: *692
+ default: *687
headers:
Link: *58
x-github:
@@ -106950,9 +106319,9 @@ paths:
application/json:
schema:
type: array
- items: *693
+ items: *688
examples:
- default: *722
+ default: *717
headers:
Link: *58
x-github:
@@ -106977,7 +106346,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *63
- - *723
+ - *718
- *52
- *17
- *19
@@ -106989,11 +106358,11 @@ paths:
schema:
anyOf:
- type: array
- items: *724
+ items: *719
- type: array
items: *70
examples:
- default-response: *696
+ default-response: *691
headers:
Link: *58
x-github:
@@ -107152,7 +106521,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &725
+ enterprise: &720
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -107210,7 +106579,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &726
+ installation: &721
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -107229,7 +106598,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &727
+ organization: &722
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -107289,13 +106658,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &728
+ repository: &723
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: &758
+ properties: &753
id:
description: Unique identifier of the repository
example: 42
@@ -107978,7 +107347,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &759
+ required: &754
- archive_url
- assignees_url
- blobs_url
@@ -108129,10 +107498,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -108208,11 +107577,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- rule: &729
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ rule: &724
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)
@@ -108435,11 +107804,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- rule: *729
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ rule: *724
sender: *4
required:
- action
@@ -108622,11 +107991,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- rule: *729
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ rule: *724
sender: *4
required:
- action
@@ -108710,7 +108079,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &731
+ check_run: &726
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -108801,7 +108170,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *730
+ deployment: *725
details_url:
example: https://example.com
type: string
@@ -108886,10 +108255,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
sender: *4
required:
- check_run
@@ -109282,11 +108651,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *731
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ check_run: *726
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
sender: *4
required:
- check_run
@@ -109682,11 +109051,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *731
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ check_run: *726
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
requested_action:
description: The action requested by the user.
type: object
@@ -110091,11 +109460,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *731
- installation: *726
- enterprise: *725
- organization: *727
- repository: *728
+ check_run: *726
+ installation: *721
+ enterprise: *720
+ organization: *722
+ repository: *723
sender: *4
required:
- check_run
@@ -111072,10 +110441,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -111769,10 +111138,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -112460,10 +111829,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -112629,7 +111998,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -112774,20 +112143,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &732
+ commit_oid: &727
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: *725
- installation: *726
- organization: *727
- ref: &733
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: &728
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: *728
+ repository: *723
sender: *4
required:
- action
@@ -112952,7 +112321,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -113182,12 +112551,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -113282,7 +112651,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -113453,12 +112822,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -113624,7 +112993,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -113790,12 +113159,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -113894,7 +113263,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -114069,16 +113438,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
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: *728
+ repository: *723
sender: *4
required:
- action
@@ -114175,7 +113544,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -114315,12 +113684,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *732
- enterprise: *725
- installation: *726
- organization: *727
- ref: *733
- repository: *728
+ commit_oid: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
+ ref: *728
+ repository: *723
sender: *4
required:
- action
@@ -114486,7 +113855,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *423
+ dismissed_comment: *420
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -114631,10 +114000,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -114889,10 +114258,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -114972,18 +114341,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *727
- pusher_type: &734
+ organization: *722
+ pusher_type: &729
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &735
+ ref: &730
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -114993,7 +114362,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *728
+ repository: *723
sender: *4
required:
- ref
@@ -115076,9 +114445,9 @@ x-webhooks:
enum:
- created
definition: *274
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115163,9 +114532,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115243,9 +114612,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *274
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115323,9 +114692,9 @@ x-webhooks:
enum:
- updated
definition: *274
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -115402,10 +114771,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- repository: *728
- organization: *727
+ enterprise: *720
+ installation: *721
+ repository: *723
+ organization: *722
sender: *4
new_property_values:
type: array
@@ -115490,18 +114859,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- pusher_type: *734
- ref: *735
+ enterprise: *720
+ installation: *721
+ organization: *722
+ pusher_type: *729
+ ref: *730
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *728
+ repository: *723
sender: *4
required:
- ref
@@ -115585,11 +114954,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115673,11 +115042,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115761,11 +115130,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115847,11 +115216,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -115933,11 +115302,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -116020,11 +115389,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -116106,11 +115475,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *485
- installation: *726
- organization: *727
- enterprise: *725
- repository: *728
+ alert: *482
+ installation: *721
+ organization: *722
+ enterprise: *720
+ repository: *723
sender: *4
required:
- action
@@ -116187,9 +115556,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- key: &736
+ enterprise: *720
+ installation: *721
+ key: &731
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -116225,8 +115594,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -116303,11 +115672,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- key: *736
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ key: *731
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -116868,12 +116237,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: &740
+ workflow: &735
title: Workflow
type: object
nullable: true
@@ -117599,13 +116968,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *491
+ deployment: *488
pull_requests:
type: array
- items: *579
- repository: *728
- organization: *727
- installation: *726
+ items: *576
+ repository: *723
+ organization: *722
+ installation: *721
sender: *4
responses:
'200':
@@ -117676,7 +117045,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &737
+ approver: &732
type: object
properties:
avatar_url:
@@ -117719,11 +117088,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- reviewers: &738
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ reviewers: &733
type: array
items:
type: object
@@ -117802,7 +117171,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &739
+ workflow_job_run: &734
type: object
properties:
conclusion:
@@ -118533,18 +117902,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *737
+ approver: *732
comment:
type: string
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- reviewers: *738
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ reviewers: *733
sender: *4
since:
type: string
- workflow_job_run: *739
+ workflow_job_run: *734
workflow_job_runs:
type: array
items:
@@ -119248,13 +118617,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *725
+ enterprise: *720
environment:
type: string
- installation: *726
- organization: *727
- repository: *728
- requestor: &745
+ installation: *721
+ organization: *722
+ repository: *723
+ requestor: &740
title: User
type: object
nullable: true
@@ -121153,12 +120522,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Deployment Workflow Run
type: object
@@ -121838,7 +121207,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &743
+ answer: &738
type: object
properties:
author_association:
@@ -121995,11 +121364,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122126,11 +121495,11 @@ x-webhooks:
- from
required:
- category
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122213,11 +121582,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122299,7 +121668,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &742
+ comment: &737
type: object
properties:
author_association:
@@ -122456,11 +121825,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122543,12 +121912,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *742
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ comment: *737
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122643,12 +122012,12 @@ x-webhooks:
- from
required:
- body
- comment: *742
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ comment: *737
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122732,11 +122101,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122818,11 +122187,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -122922,11 +122291,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123008,10 +122377,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *741
- enterprise: *725
- installation: *726
- label: &744
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ label: &739
title: Label
type: object
properties:
@@ -123043,8 +122412,8 @@ x-webhooks:
- color
- default
- description
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123127,11 +122496,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123213,11 +122582,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123299,11 +122668,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123388,16 +122757,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *741
- new_repository: *728
+ new_discussion: *736
+ new_repository: *723
required:
- new_discussion
- new_repository
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123480,10 +122849,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *741
- old_answer: *743
- organization: *727
- repository: *728
+ discussion: *736
+ old_answer: *738
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123565,12 +122934,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *741
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123653,11 +123022,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123739,11 +123108,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *741
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ discussion: *736
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -123816,7 +123185,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *725
+ enterprise: *720
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -124476,9 +123845,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- forkee
@@ -124624,9 +123993,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pages:
description: The pages that were updated.
type: array
@@ -124663,7 +124032,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *728
+ repository: *723
sender: *4
required:
- pages
@@ -124739,10 +124108,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: &746
+ organization: *722
+ repositories: &741
description: An array of repository objects that the installation
can access.
type: array
@@ -124768,8 +124137,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *728
- requester: *745
+ repository: *723
+ requester: *740
sender: *4
required:
- action
@@ -124844,11 +124213,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -124924,11 +124293,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -125004,10 +124373,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories_added: &747
+ organization: *722
+ repositories_added: &742
description: An array of repository objects, which were added to
the installation.
type: array
@@ -125053,15 +124422,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *728
- repository_selection: &748
+ repository: *723
+ repository_selection: &743
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *745
+ requester: *740
sender: *4
required:
- action
@@ -125140,10 +124509,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories_added: *747
+ organization: *722
+ repositories_added: *742
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -125170,9 +124539,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *728
- repository_selection: *748
- requester: *745
+ repository: *723
+ repository_selection: *743
+ requester: *740
sender: *4
required:
- action
@@ -125251,11 +124620,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -125433,10 +124802,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
target_type:
type: string
@@ -125515,11 +124884,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *725
+ enterprise: *720
installation: *22
- organization: *727
- repositories: *746
- repository: *728
+ organization: *722
+ repositories: *741
+ repository: *723
requester:
nullable: true
sender: *4
@@ -125771,8 +125140,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -126566,8 +125935,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126916,8 +126285,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -126997,7 +126366,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &749
+ comment: &744
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -127162,8 +126531,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -127953,8 +127322,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128305,8 +127674,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -128386,7 +127755,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &778
+ changes: &773
description: The changes to the comment.
type: object
properties:
@@ -128398,9 +127767,9 @@ x-webhooks:
type: string
required:
- from
- comment: *749
- enterprise: *725
- installation: *726
+ comment: *744
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -129193,8 +128562,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129543,8 +128912,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129634,9 +129003,9 @@ x-webhooks:
type: number
blocking_issue: *74
blocking_issue_repo: *70
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129725,9 +129094,9 @@ x-webhooks:
type: number
blocking_issue: *74
blocking_issue_repo: *70
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129815,9 +129184,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129906,9 +129275,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -129988,10 +129357,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *745
- enterprise: *725
- installation: *726
- issue: &752
+ assignee: *740
+ enterprise: *720
+ installation: *721
+ issue: &747
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -130780,11 +130149,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -130901,8 +130270,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -130982,8 +130351,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -131777,11 +131146,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132033,8 +131402,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -132113,8 +131482,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -132899,11 +132268,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -133019,8 +132388,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -133099,8 +132468,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -133907,11 +133276,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134006,7 +133375,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &750
+ milestone: &745
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -134144,8 +133513,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -134244,8 +133613,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -135034,11 +134403,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -135155,9 +134524,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *744
- organization: *727
- repository: *728
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -135237,8 +134606,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -136026,11 +135395,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -136147,9 +135516,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *744
- organization: *727
- repository: *728
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -136229,8 +135598,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -137042,11 +136411,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -137140,8 +136509,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -137220,8 +136589,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -138027,11 +137396,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -138125,9 +137494,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *750
- organization: *727
- repository: *728
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -138995,11 +138364,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -139561,8 +138930,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -140351,11 +139720,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -140471,8 +139840,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -140552,9 +139921,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *725
- installation: *726
- issue: &751
+ enterprise: *720
+ installation: *721
+ issue: &746
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -141337,11 +140706,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -141457,8 +140826,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -141537,8 +140906,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -142348,11 +141717,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -142447,8 +141816,8 @@ x-webhooks:
user_view_type:
type: string
type: *227
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -143314,11 +142683,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143902,11 +143271,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *725
- installation: *726
- issue: *751
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *746
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -143986,12 +143355,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *725
- installation: *726
- issue: *752
+ enterprise: *720
+ installation: *721
+ issue: *747
type: *227
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -144072,7 +143441,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &781
+ assignee: &776
title: User
type: object
nullable: true
@@ -144142,11 +143511,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *725
- installation: *726
- issue: *752
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *747
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -144225,12 +143594,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *725
- installation: *726
- issue: *752
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *747
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -144310,8 +143679,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -145121,11 +144490,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *657
- issue_dependencies_summary: *658
+ sub_issues_summary: *654
+ issue_dependencies_summary: *655
issue_field_values:
type: array
- items: *659
+ items: *656
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145219,8 +144588,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145300,11 +144669,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *725
- installation: *726
- issue: *751
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ issue: *746
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145383,12 +144752,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *725
- installation: *726
- issue: *752
+ enterprise: *720
+ installation: *721
+ issue: *747
type: *227
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145468,11 +144837,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145550,11 +144919,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145664,11 +145033,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- label: *744
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ label: *739
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -145750,9 +145119,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: &753
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: &748
title: Marketplace Purchase
type: object
required:
@@ -145835,8 +145204,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *727
- previous_marketplace_purchase: &754
+ organization: *722
+ previous_marketplace_purchase: &749
title: Marketplace Purchase
type: object
properties:
@@ -145916,7 +145285,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -145996,10 +145365,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: *753
- organization: *727
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: *748
+ organization: *722
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -146082,7 +145451,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -146164,10 +145533,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: *753
- organization: *727
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: *748
+ organization: *722
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -146249,7 +145618,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -146330,8 +145699,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -146413,9 +145782,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *727
- previous_marketplace_purchase: *754
- repository: *728
+ organization: *722
+ previous_marketplace_purchase: *749
+ repository: *723
sender: *4
required:
- action
@@ -146495,12 +145864,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *725
- installation: *726
- marketplace_purchase: *753
- organization: *727
- previous_marketplace_purchase: *754
- repository: *728
+ enterprise: *720
+ installation: *721
+ marketplace_purchase: *748
+ organization: *722
+ previous_marketplace_purchase: *749
+ repository: *723
sender: *4
required:
- action
@@ -146602,11 +145971,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -146706,11 +146075,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -146789,11 +146158,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -146871,11 +146240,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -146951,7 +146320,7 @@ x-webhooks:
required:
- login
- id
- team: &755
+ team: &750
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -147174,11 +146543,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *725
- installation: *726
- member: *745
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ member: *740
+ organization: *722
+ repository: *723
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -147255,7 +146624,7 @@ x-webhooks:
required:
- login
- id
- team: *755
+ team: *750
required:
- action
- scope
@@ -147337,8 +146706,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *726
- merge_group: &757
+ installation: *721
+ merge_group: &752
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -147357,15 +146726,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *756
+ head_commit: *751
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -147451,10 +146820,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *726
- merge_group: *757
- organization: *727
- repository: *728
+ installation: *721
+ merge_group: *752
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -147527,7 +146896,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
+ enterprise: *720
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -147636,16 +147005,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -147726,11 +147095,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
- milestone: *750
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -147809,9 +147178,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- milestone: &760
+ enterprise: *720
+ installation: *721
+ milestone: &755
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -147948,8 +147317,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148028,11 +147397,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- milestone: *750
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148142,11 +147511,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- milestone: *750
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *745
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148226,11 +147595,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *725
- installation: *726
- milestone: *760
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ milestone: *755
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148309,11 +147678,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *745
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ blocked_user: *740
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148392,11 +147761,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *745
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ blocked_user: *740
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148475,9 +147844,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- membership: &761
+ enterprise: *720
+ installation: *721
+ membership: &756
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -148584,8 +147953,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148663,11 +148032,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *725
- installation: *726
- membership: *761
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ membership: *756
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -148746,8 +148115,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -148863,10 +148232,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
- user: *745
+ user: *740
required:
- action
- invitation
@@ -148944,11 +148313,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *725
- installation: *726
- membership: *761
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ membership: *756
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -149035,11 +148404,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *725
- installation: *726
- membership: *761
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ membership: *756
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -149115,9 +148484,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
package:
description: Information about the package.
type: object
@@ -149616,7 +148985,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &762
+ items: &757
title: Ruby Gems metadata
type: object
properties:
@@ -149711,7 +149080,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -149787,9 +149156,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
package:
description: Information about the package.
type: object
@@ -150142,7 +149511,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *762
+ items: *757
source_url:
type: string
format: uri
@@ -150212,7 +149581,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -150389,12 +149758,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *725
+ enterprise: *720
id:
type: integer
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- id
@@ -150471,7 +149840,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &763
+ personal_access_token_request: &758
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -150617,10 +149986,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *725
- organization: *727
+ enterprise: *720
+ organization: *722
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150697,11 +150066,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *763
- enterprise: *725
- organization: *727
+ personal_access_token_request: *758
+ enterprise: *720
+ organization: *722
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150777,11 +150146,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *763
- enterprise: *725
- organization: *727
+ personal_access_token_request: *758
+ enterprise: *720
+ organization: *722
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150856,11 +150225,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *763
- organization: *727
- enterprise: *725
+ personal_access_token_request: *758
+ organization: *722
+ enterprise: *720
sender: *4
- installation: *726
+ installation: *721
required:
- action
- personal_access_token_request
@@ -150965,7 +150334,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *764
+ last_response: *759
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -150997,8 +150366,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
zen:
description: Random string of GitHub zen.
@@ -151243,10 +150612,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *725
- installation: *726
- organization: *727
- project_card: &765
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_card: &760
title: Project Card
type: object
properties:
@@ -151365,7 +150734,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -151446,11 +150815,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- project_card: *765
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_card: *760
+ repository: *723
sender: *4
required:
- action
@@ -151530,9 +150899,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
project_card:
title: Project Card
type: object
@@ -151660,8 +151029,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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -151755,11 +151124,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *725
- installation: *726
- organization: *727
- project_card: *765
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_card: *760
+ repository: *723
sender: *4
required:
- action
@@ -151853,9 +151222,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
project_card:
allOf:
- title: Project Card
@@ -152045,7 +151414,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -152125,10 +151494,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
- organization: *727
- project: &767
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: &762
title: Project
type: object
properties:
@@ -152252,7 +151621,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -152332,10 +151701,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- project_column: &766
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: &761
title: Project Column
type: object
properties:
@@ -152374,7 +151743,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -152453,18 +151822,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- project_column: *766
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: *761
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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -152554,11 +151923,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- project_column: *766
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: *761
+ repository: *723
sender: *4
required:
- action
@@ -152638,11 +152007,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *725
- installation: *726
- organization: *727
- project_column: *766
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project_column: *761
+ repository: *723
sender: *4
required:
- action
@@ -152722,11 +152091,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
+ repository: *723
sender: *4
required:
- action
@@ -152806,18 +152175,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
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: *758
- required: *759
+ properties: *753
+ required: *754
nullable: true
sender: *4
required:
@@ -152919,11 +152288,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
+ repository: *723
sender: *4
required:
- action
@@ -153002,11 +152371,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *725
- installation: *726
- organization: *727
- project: *767
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ project: *762
+ repository: *723
sender: *4
required:
- action
@@ -153087,8 +152456,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153170,8 +152539,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153253,8 +152622,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153372,8 +152741,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -153457,7 +152826,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &771
+ changes: &766
type: object
properties:
archived_at:
@@ -153471,9 +152840,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *726
- organization: *727
- projects_v2_item: &768
+ installation: *721
+ organization: *722
+ projects_v2_item: &763
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -153608,9 +152977,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -153692,9 +153061,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -153775,9 +153144,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -153883,7 +153252,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &769
+ - &764
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -153905,7 +153274,7 @@ x-webhooks:
required:
- id
- name
- - &770
+ - &765
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -153939,8 +153308,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *769
- - *770
+ - *764
+ - *765
required:
- field_value
- type: object
@@ -153956,9 +153325,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -154053,9 +153422,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *726
- organization: *727
- projects_v2_item: *768
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -154138,10 +153507,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *771
- installation: *726
- organization: *727
- projects_v2_item: *768
+ changes: *766
+ installation: *721
+ organization: *722
+ projects_v2_item: *763
sender: *4
required:
- action
@@ -154223,8 +153592,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
projects_v2: *261
sender: *4
required:
@@ -154306,14 +153675,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *726
- organization: *727
- projects_v2_status_update: &774
+ installation: *721
+ organization: *722
+ projects_v2_status_update: &769
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *772
- required: *773
+ properties: *767
+ required: *768
sender: *4
required:
- action
@@ -154394,9 +153763,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *726
- organization: *727
- projects_v2_status_update: *774
+ installation: *721
+ organization: *722
+ projects_v2_status_update: *769
sender: *4
required:
- action
@@ -154532,9 +153901,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *726
- organization: *727
- projects_v2_status_update: *774
+ installation: *721
+ organization: *722
+ projects_v2_status_update: *769
sender: *4
required:
- action
@@ -154605,10 +153974,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- repository
@@ -154685,13 +154054,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *745
- enterprise: *725
- installation: *726
- number: &775
+ assignee: *740
+ enterprise: *720
+ installation: *721
+ number: &770
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -156974,7 +156343,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -157056,11 +156425,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -159338,7 +158707,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -159420,11 +158789,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -161702,7 +161071,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -161784,13 +161153,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: &776
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: &771
allOf:
- - *579
+ - *576
- type: object
properties:
allow_auto_merge:
@@ -161852,7 +161221,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -161933,12 +161302,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -162018,11 +161387,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *725
- milestone: *561
- number: *775
- organization: *727
- pull_request: &777
+ enterprise: *720
+ milestone: *558
+ number: *770
+ organization: *722
+ pull_request: &772
title: Pull Request
type: object
properties:
@@ -164285,7 +163654,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -164364,11 +163733,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -166650,7 +166019,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -166774,12 +166143,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -166859,11 +166228,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -169130,7 +168499,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -169210,11 +168579,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *725
- installation: *726
- label: *744
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ label: *739
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -171496,7 +170865,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -171577,10 +170946,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -173860,7 +173229,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -173940,12 +173309,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *725
- milestone: *561
- number: *775
- organization: *727
- pull_request: *777
- repository: *728
+ enterprise: *720
+ milestone: *558
+ number: *770
+ organization: *722
+ pull_request: *772
+ repository: *723
sender: *4
required:
- action
@@ -174024,12 +173393,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -174110,12 +173479,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -174195,12 +173564,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
- pull_request: *776
- repository: *728
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
+ pull_request: *771
+ repository: *723
sender: *4
required:
- action
@@ -174566,9 +173935,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
type: object
properties:
@@ -176738,7 +176107,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -176818,7 +176187,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &779
+ comment: &774
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -177103,9 +176472,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
type: object
properties:
@@ -179263,7 +178632,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -179343,11 +178712,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *778
- comment: *779
- enterprise: *725
- installation: *726
- organization: *727
+ changes: *773
+ comment: *774
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
type: object
properties:
@@ -181508,7 +180877,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -181589,9 +180958,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -183764,7 +183133,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
+ repository: *723
review:
description: The review that was affected.
type: object
@@ -184011,9 +183380,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -186067,8 +185436,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
- review: &780
+ repository: *723
+ review: &775
description: The review that was affected.
type: object
properties:
@@ -186301,12 +185670,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -188589,7 +187958,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_reviewer:
title: User
type: object
@@ -188673,12 +188042,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -190968,7 +190337,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -191160,12 +190529,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -193450,7 +192819,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_reviewer:
title: User
type: object
@@ -193535,12 +192904,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *725
- installation: *726
+ enterprise: *720
+ installation: *721
number:
description: The pull request number.
type: integer
- organization: *727
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -195816,7 +195185,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -195997,9 +195366,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -198174,8 +197543,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
- review: *780
+ repository: *723
+ review: *775
sender: *4
required:
- action
@@ -198255,9 +197624,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -200327,7 +199696,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
thread:
type: object
@@ -200714,9 +200083,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
pull_request:
title: Simple Pull Request
type: object
@@ -202772,7 +202141,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *728
+ repository: *723
sender: *4
thread:
type: object
@@ -203162,10 +202531,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -205436,7 +204805,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -205518,11 +204887,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *781
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ assignee: *776
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -207805,7 +207174,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -207884,11 +207253,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *725
- installation: *726
- label: *744
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ label: *739
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -210161,7 +209530,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -210242,10 +209611,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *725
- installation: *726
- number: *775
- organization: *727
+ enterprise: *720
+ installation: *721
+ number: *770
+ organization: *722
pull_request:
title: Pull Request
type: object
@@ -212510,7 +211879,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -212710,7 +212079,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *725
+ enterprise: *720
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -212802,8 +212171,8 @@ x-webhooks:
- url
- author
- committer
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -213378,9 +212747,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
registry_package:
type: object
properties:
@@ -213826,7 +213195,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *762
+ items: *757
summary:
type: string
tag_name:
@@ -213880,7 +213249,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -213958,9 +213327,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
registry_package:
type: object
properties:
@@ -214268,7 +213637,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *762
+ items: *757
summary:
type: string
tag_name:
@@ -214317,7 +213686,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -214394,10 +213763,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- release: &782
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: &777
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -214715,7 +214084,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -214792,11 +214161,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- release: *782
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *777
+ repository: *723
sender: *4
required:
- action
@@ -214913,11 +214282,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *725
- installation: *726
- organization: *727
- release: *782
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *777
+ repository: *723
sender: *4
required:
- action
@@ -214995,9 +214364,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -215319,7 +214688,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -215395,10 +214764,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
- release: &783
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: &778
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -215717,7 +215086,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *728
+ repository: *723
sender: *4
required:
- action
@@ -215793,11 +215162,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *725
- installation: *726
- organization: *727
- release: *782
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *777
+ repository: *723
sender: *4
required:
- action
@@ -215873,11 +215242,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *725
- installation: *726
- organization: *727
- release: *783
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ release: *778
+ repository: *723
sender: *4
required:
- action
@@ -215953,11 +215322,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- repository_advisory: *643
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ repository_advisory: *640
sender: *4
required:
- action
@@ -216033,11 +215402,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- repository_advisory: *643
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ repository_advisory: *640
sender: *4
required:
- action
@@ -216113,10 +215482,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216193,10 +215562,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216274,10 +215643,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216361,10 +215730,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216476,10 +215845,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216551,10 +215920,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
status:
type: string
@@ -216635,10 +216004,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216715,10 +216084,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216812,10 +216181,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -216895,10 +216264,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
repository_ruleset: *307
sender: *4
required:
@@ -216977,10 +216346,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
repository_ruleset: *307
sender: *4
required:
@@ -217059,10 +216428,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
repository_ruleset: *307
changes:
type: object
@@ -217124,16 +216493,16 @@ x-webhooks:
properties:
added:
type: array
- items: *599
+ items: *596
deleted:
type: array
- items: *599
+ items: *596
updated:
type: array
items:
type: object
properties:
- rule: *599
+ rule: *596
changes:
type: object
properties:
@@ -217367,10 +216736,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217448,10 +216817,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217529,7 +216898,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &784
+ alert: &779
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -217650,10 +217019,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217859,10 +217228,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -217940,11 +217309,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *784
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *779
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218143,10 +217512,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218224,7 +217593,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &785
+ alert: &780
type: object
properties:
number: *169
@@ -218343,10 +217712,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218424,11 +217793,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218509,11 +217878,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *785
- installation: *726
- location: *786
- organization: *727
- repository: *728
+ alert: *780
+ installation: *721
+ location: *781
+ organization: *722
+ repository: *723
sender: *4
required:
- location
@@ -218751,11 +218120,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218833,11 +218202,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218915,11 +218284,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -218997,12 +218366,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *785
+ alert: *780
assignee: *4
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -219080,11 +218449,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *785
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ alert: *780
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -219210,10 +218579,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *728
- enterprise: *725
- installation: *726
- organization: *727
+ repository: *723
+ enterprise: *720
+ installation: *721
+ organization: *722
sender: *4
required:
- action
@@ -219291,11 +218660,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- security_advisory: &787
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ security_advisory: &782
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -219478,11 +218847,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
- security_advisory: *787
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
+ security_advisory: *782
sender: *4
required:
- action
@@ -219555,10 +218924,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -219743,10 +219112,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *280
- enterprise: *725
- installation: *726
- organization: *727
- repository: *333
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *330
sender: *4
required:
- changes
@@ -219824,12 +219193,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: &788
+ sponsorship: &783
type: object
properties:
created_at:
@@ -220130,12 +219499,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- sponsorship
@@ -220223,12 +219592,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- changes
@@ -220305,17 +219674,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &789
+ effective_date: &784
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: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- sponsorship
@@ -220389,7 +219758,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &790
+ changes: &785
type: object
properties:
tier:
@@ -220433,13 +219802,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *789
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ effective_date: *784
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- changes
@@ -220516,13 +219885,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *790
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ changes: *785
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- sponsorship: *788
+ sponsorship: *783
required:
- action
- changes
@@ -220596,10 +219965,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -220682,10 +220051,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -221105,15 +220474,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *725
+ enterprise: *720
id:
description: The unique identifier of the status.
type: integer
- installation: *726
+ installation: *721
name:
type: string
- organization: *727
- repository: *728
+ organization: *722
+ repository: *723
sender: *4
sha:
description: The Commit SHA.
@@ -221228,9 +220597,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221320,9 +220689,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221412,9 +220781,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221504,9 +220873,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *74
- installation: *726
- organization: *727
- repository: *728
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -221583,12 +220952,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- team: &791
+ team: &786
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -221811,9 +221180,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -222271,7 +221640,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -222347,9 +221716,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -222807,7 +222176,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -222884,9 +222253,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -223344,7 +222713,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -223488,9 +222857,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -223948,7 +223317,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- changes
@@ -224026,9 +223395,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *725
- installation: *726
- organization: *727
+ enterprise: *720
+ installation: *721
+ organization: *722
repository:
title: Repository
description: A git repository
@@ -224486,7 +223855,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *791
+ team: *786
required:
- action
- team
@@ -224562,10 +223931,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
required:
- action
@@ -224638,16 +224007,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *725
+ enterprise: *720
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *726
- organization: *727
+ installation: *721
+ organization: *722
ref:
type: string
- repository: *728
+ repository: *723
sender: *4
workflow:
type: string
@@ -224729,10 +224098,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
allOf:
@@ -224969,7 +224338,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225048,10 +224417,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
allOf:
@@ -225311,7 +224680,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225390,10 +224759,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
type: object
@@ -225528,7 +224897,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225607,10 +224976,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
workflow_job:
type: object
@@ -225746,7 +225115,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *491
+ deployment: *488
required:
- action
- repository
@@ -225826,12 +225195,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Workflow Run
type: object
@@ -226830,12 +226199,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Workflow Run
type: object
@@ -227819,12 +227188,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *725
- installation: *726
- organization: *727
- repository: *728
+ enterprise: *720
+ installation: *721
+ organization: *722
+ repository: *723
sender: *4
- workflow: *740
+ workflow: *735
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
index 0af53747a..ae1f4de04 100644
--- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
+++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
@@ -250894,15 +250894,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -251012,8 +251003,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -251055,8 +251044,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -251320,15 +251307,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -251438,8 +251416,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -251479,8 +251455,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -251710,15 +251684,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -251828,8 +251793,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -251869,8 +251832,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -252124,15 +252085,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -252242,8 +252194,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -252283,8 +252233,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -252375,17 +252323,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-in-org",
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -252405,28 +252353,380 @@
"schema": {
"type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
+ }
+ },
+ "required": [
+ "group_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "delete": {
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/invitations": {
+ "get": {
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-pending-invitations-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
@@ -252456,11 +252756,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -252582,125 +252908,34 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ ]
},
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "team_count": {
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
},
- "updated_at": {
+ "invitation_teams_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
},
- "url": {
+ "invitation_source": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "example": "\"member\""
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
+ "id",
+ "login",
+ "email",
+ "role",
"created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
]
}
},
@@ -252708,49 +252943,37 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "avatar_url": "https://github.com/images/error/other_user_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",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
}
]
}
@@ -252771,19 +252994,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -252805,298 +253030,175 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "integer"
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
+ },
+ {
+ "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
}
}
- },
+ ],
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "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"
- }
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
+ "email": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
+ "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"
+ ]
+ }
},
"examples": {
"default": {
- "value": {
- "author": {
+ "value": [
+ {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -253115,57 +253217,41 @@
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
}
- }
+ ]
}
}
}
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
}
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
"get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -253187,21 +253273,12 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
@@ -253211,323 +253288,73 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
"value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
}
}
}
}
}
+ },
+ "404": {
+ "description": "if user has no team membership"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -253549,44 +253376,38 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "body": "Do you like pineapples?"
+ "role": "maintainer"
}
}
}
@@ -253599,499 +253420,76 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
},
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/external-groups": {
- "get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "operationId": "teams/remove-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -254111,218 +253509,10 @@
"schema": {
"type": "string"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
@@ -254333,27 +253523,30 @@
"responses": {
"204": {
"description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "external-groups"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/invitations": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-pending-invitations-in-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories"
},
"parameters": [
{
@@ -254401,37 +253594,28 @@
"schema": {
"type": "array",
"items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
"type": "object",
"properties": {
"id": {
"type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
+ "format": "int64",
+ "example": 1296269
},
- "email": {
+ "node_id": {
"type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
- "failed_at": {
+ "name": {
"type": "string",
- "nullable": true
+ "example": "Hello-World"
},
- "failed_reason": {
+ "full_name": {
"type": "string",
- "nullable": true
+ "example": "octocat/Hello-World"
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -254555,1011 +253739,182 @@
"url"
]
},
- "team_count": {
- "type": "integer"
+ "private": {
+ "type": "boolean"
},
- "node_id": {
+ "html_url": {
"type": "string",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
},
- "invitation_teams_url": {
+ "description": {
"type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "example": "This your first repo!",
+ "nullable": true
},
- "invitation_source": {
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
- "example": "\"member\""
- }
- },
- "required": [
- "id",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_id"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1,
- "login": "monalisa",
- "node_id": "MDQ6VXNlcjE=",
- "email": "octocat@github.com",
- "role": "direct_member",
- "created_at": "2016-11-30T06:46:10-08:00",
- "failed_at": "",
- "failed_reason": "",
- "inviter": {
- "login": "other_user",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/other_user_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/other_user",
- "html_url": "https://github.com/other_user",
- "followers_url": "https://api.github.com/users/other_user/followers",
- "following_url": "https://api.github.com/users/other_user/following{/other_user}",
- "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
- "organizations_url": "https://api.github.com/users/other_user/orgs",
- "repos_url": "https://api.github.com/users/other_user/repos",
- "events_url": "https://api.github.com/users/other_user/events{/privacy}",
- "received_events_url": "https://api.github.com/users/other_user/received_events",
- "type": "User",
- "site_admin": false
- },
- "team_count": 2,
- "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
- "invitation_source": "member"
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
- "login": {
+ "assignees_url": {
"type": "string",
- "example": "octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
- "node_id": {
+ "branches_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
- "avatar_url": {
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
- "gravatar_id": {
+ "deployments_url": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
- "url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
- "html_url": {
+ "events_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
},
- "followers_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
- "following_url": {
+ "git_commits_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
- "gists_url": {
+ "git_refs_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
- "starred_url": {
+ "git_tags_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
- "subscriptions_url": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
- "organizations_url": {
+ "merges_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
- "repos_url": {
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
- "events_url": {
+ "statuses_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
- "received_events_url": {
+ "subscribers_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
- "type": {
+ "subscription_url": {
"type": "string",
- "example": "User"
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
- "site_admin": {
- "type": "boolean"
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
- "starred_at": {
+ "teams_url": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
- "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"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "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
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- },
- "422": {
- "description": "Unprocessable Entity if you attempt to add an organization to a team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "delete": {
- "summary": "Remove team membership for a user",
- "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/remove-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/repos": {
- "get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-repos-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
- },
- "node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
- "nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
+ "trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
@@ -598200,1688 +596555,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- },
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -599891,41 +596571,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -599984,10 +596679,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -600017,19 +596715,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -600062,20 +596763,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Create a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-legacy",
+ "operationId": "teams/create-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy"
},
"parameters": [
{
@@ -600086,15 +596787,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -600104,19 +596796,30 @@
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
}
},
"required": [
+ "title",
"body"
]
},
"examples": {
"default": {
"value": {
- "body": "Do you like apples?"
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
}
}
}
@@ -600129,8 +596832,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -600259,13 +596962,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -600275,41 +596978,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -600368,10 +597086,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -600399,19 +597120,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -600436,22 +597160,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/teams/{team_id}/discussions/{discussion_number}": {
"get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-legacy",
+ "operationId": "teams/get-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
},
"parameters": [
{
@@ -600471,15 +597195,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -600488,8 +597203,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -600618,13 +597333,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -600634,41 +597349,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -600727,10 +597457,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -600758,19 +597491,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -600794,20 +597530,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Update a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-legacy",
+ "operationId": "teams/update-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy"
},
"parameters": [
{
@@ -600827,37 +597563,29 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "body": "Do you like pineapples?"
+ "title": "Welcome to our first team post"
}
}
}
@@ -600870,8 +597598,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -601000,13 +597728,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -601016,41 +597744,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -601109,10 +597852,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -601140,19 +597886,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
"updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -601176,20 +597925,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-legacy",
+ "operationId": "teams/delete-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
},
"parameters": [
{
@@ -601209,15 +597958,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -601231,7 +597971,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml
index de485af58..1fe82ed32 100644
--- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml
+++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml
@@ -1029,7 +1029,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &758
+ - &755
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1713,7 +1713,7 @@ paths:
application/json:
schema: *3
application/scim+json:
- schema: &768
+ schema: &765
title: Scim Error
description: Scim Error
type: object
@@ -8897,7 +8897,7 @@ paths:
value:
days: 90
maximum_allowed_days: 365
- '401': &769
+ '401': &766
description: Authorization failure
'404': *6
x-github:
@@ -13108,7 +13108,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &536
+ instances_url: &533
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -13143,7 +13143,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &537
+ dismissed_reason: &534
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -13152,13 +13152,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &538
+ dismissed_comment: &535
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &539
+ rule: &536
type: object
properties:
id:
@@ -13211,7 +13211,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &540
+ tool: &537
type: object
properties:
name: *111
@@ -13221,26 +13221,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *112
- most_recent_instance: &541
+ most_recent_instance: &538
type: object
properties:
- ref: &534
+ ref: &531
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &551
+ analysis_key: &548
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
this includes the workflow filename and job name.
- environment: &552
+ environment: &549
type: string
description: Identifies the variable values associated with
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &553
+ category: &550
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -13254,7 +13254,7 @@ paths:
properties:
text:
type: string
- location: &554
+ location: &551
type: object
description: Describe a region within a file for the alert.
properties:
@@ -13275,7 +13275,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &555
+ items: &552
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -16938,7 +16938,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
- - &596
+ - &593
name: has
in: query
description: |-
@@ -17051,7 +17051,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &597
+ security_advisory: &594
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -17283,14 +17283,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *137
- auto_dismissed_at: &598
+ auto_dismissed_at: &595
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &599
+ dismissal_request: &596
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -20775,7 +20775,7 @@ paths:
- *164
rules:
type: array
- items: &724
+ items: &721
title: Repository Rule
type: object
description: A repository rule.
@@ -20784,7 +20784,7 @@ paths:
- *170
- *171
- *172
- - &722
+ - &719
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -21347,14 +21347,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &736
+ state: &733
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: &737
+ resolution: &734
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -21461,8 +21461,8 @@ paths:
pull request.
'
- oneOf: &738
- - &740
+ oneOf: &735
+ - &737
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -21514,7 +21514,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &741
+ - &738
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -21569,7 +21569,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &742
+ - &739
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -21583,7 +21583,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &743
+ - &740
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -21597,7 +21597,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &744
+ - &741
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -21611,7 +21611,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &745
+ - &742
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -21625,7 +21625,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &746
+ - &743
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -21639,7 +21639,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &747
+ - &744
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -21653,7 +21653,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &748
+ - &745
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -21667,7 +21667,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &749
+ - &746
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -21681,7 +21681,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &750
+ - &747
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -21695,7 +21695,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &751
+ - &748
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -21709,7 +21709,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &752
+ - &749
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -25003,7 +25003,7 @@ paths:
properties:
action:
type: string
- discussion: &878
+ discussion: &873
title: Discussion
description: A Discussion in a repository.
type: object
@@ -25370,7 +25370,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &660
+ properties: &657
id:
type: integer
format: int64
@@ -25747,7 +25747,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &796
+ sub_issues_summary: &793
title: Sub-issues Summary
type: object
properties:
@@ -25767,7 +25767,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &797
+ issue_dependencies_summary: &794
title: Issue Dependencies Summary
type: object
properties:
@@ -25786,7 +25786,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &798
+ items: &795
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -25847,7 +25847,7 @@ paths:
- node_id
- data_type
- value
- required: &661
+ required: &658
- assignee
- closed_at
- comments
@@ -25885,7 +25885,7 @@ paths:
action:
type: string
issue: *220
- comment: &656
+ comment: &653
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -26604,7 +26604,7 @@ paths:
type: string
release:
allOf:
- - &715
+ - &712
title: Release
description: A release.
type: object
@@ -26675,7 +26675,7 @@ paths:
author: *4
assets:
type: array
- items: &716
+ items: &713
title: Release Asset
description: Data related to a release.
type: object
@@ -27254,7 +27254,7 @@ paths:
url:
type: string
format: uri
- user: &808
+ user: &803
title: Public User
description: Public User
type: object
@@ -30559,14 +30559,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &462
+ - &459
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &463
+ - &460
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -30628,7 +30628,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &468
+ '301': &465
description: Moved permanently
content:
application/json:
@@ -30650,7 +30650,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &689
+ - &686
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -30658,7 +30658,7 @@ paths:
schema:
type: boolean
default: false
- - &690
+ - &687
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -30668,7 +30668,7 @@ paths:
type: boolean
default: false
- *227
- - &691
+ - &688
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:
@@ -31150,7 +31150,7 @@ paths:
- url
- subscription_url
examples:
- default: &692
+ default: &689
value:
- id: '1'
repository:
@@ -32267,7 +32267,7 @@ paths:
type: array
items: *155
examples:
- default: &698
+ default: &695
value:
- property_name: environment
value: production
@@ -32317,7 +32317,7 @@ paths:
required:
- properties
examples:
- default: &699
+ default: &696
value:
properties:
- property_name: environment
@@ -33130,7 +33130,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &475
+ items: &472
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -35244,7 +35244,7 @@ paths:
type: array
items: *283
examples:
- default: &811
+ default: &806
value:
total_count: 1
repositories:
@@ -36286,7 +36286,7 @@ paths:
description: Response
content:
application/json:
- schema: &495
+ schema: &492
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -36315,7 +36315,7 @@ paths:
- key_id
- key
examples:
- default: &496
+ default: &493
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -36728,7 +36728,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables
parameters:
- *87
- - &480
+ - &477
name: per_page
description: The number of results per page (max 30). For more information,
see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -37942,12 +37942,12 @@ paths:
required:
- subject_digests
examples:
- default: &839
+ default: &834
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &840
+ withPredicateType: &835
value:
subject_digests:
- sha256:abc123
@@ -38005,7 +38005,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &841
+ default: &836
value:
attestations_subject_digests:
- sha256:abc:
@@ -38354,7 +38354,7 @@ paths:
initiator:
type: string
examples:
- default: &509
+ default: &506
value:
attestations:
- bundle:
@@ -39271,7 +39271,7 @@ paths:
be returned.
in: query
required: false
- schema: &535
+ schema: &532
type: string
description: Severity of a code scanning alert.
enum:
@@ -40325,7 +40325,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &567
+ properties: &564
name:
type: string
description: The name of the machine.
@@ -40367,7 +40367,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &568
+ required: &565
- name
- display_name
- operating_system
@@ -41235,7 +41235,7 @@ paths:
- updated_at
- visibility
examples:
- default: &569
+ default: &566
value:
total_count: 2
secrets:
@@ -41273,7 +41273,7 @@ paths:
description: Response
content:
application/json:
- schema: &570
+ schema: &567
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -41302,7 +41302,7 @@ paths:
- key_id
- key
examples:
- default: &571
+ default: &568
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -41334,7 +41334,7 @@ paths:
application/json:
schema: *327
examples:
- default: &573
+ default: &570
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -43193,7 +43193,7 @@ paths:
description: Response
content:
application/json:
- schema: &602
+ schema: &599
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -43210,7 +43210,7 @@ paths:
- key_id
- key
examples:
- default: &603
+ default: &600
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -43540,7 +43540,7 @@ paths:
subcategory: alert-dismissal-requests
parameters:
- *87
- - &611
+ - &608
name: reviewer
description: Filter alert dismissal requests by the handle of the GitHub user
who reviewed the dismissal request.
@@ -43548,7 +43548,7 @@ paths:
required: false
schema:
type: string
- - &612
+ - &609
name: requester
description: Filter alert dismissal requests by the handle of the GitHub user
who requested the dismissal.
@@ -43556,7 +43556,7 @@ paths:
required: false
schema:
type: string
- - &613
+ - &610
name: time_period
description: |-
The time period to filter by.
@@ -43572,7 +43572,7 @@ paths:
- week
- month
default: month
- - &614
+ - &611
name: request_status
description: Filter alert dismissal requests by status. When specified, only
requests with this status will be returned.
@@ -43597,7 +43597,7 @@ paths:
application/json:
schema:
type: array
- items: &615
+ items: &612
title: Code scanning alert dismissal request
description: Alert dismisal request made by a user asking to dismiss
a code scanning alert.
@@ -43753,7 +43753,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/code-scanning/alerts/1
examples:
- default: &616
+ default: &613
value:
- id: 21
number: 42
@@ -43871,7 +43871,7 @@ paths:
application/json:
schema:
type: array
- items: &617
+ items: &614
title: Dependabot alert dismissal request
description: Alert dismissal request made by a user asking to dismiss
a Dependabot alert.
@@ -43988,7 +43988,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/dependabot/1
examples:
- default: &618
+ default: &615
value:
- id: 21
number: 42
@@ -44090,7 +44090,7 @@ paths:
application/json:
schema:
type: array
- items: &619
+ items: &616
title: Secret scanning alert dismissal request
description: A dismissal request made by a user asking to close
a secret scanning alert in this repository.
@@ -44211,7 +44211,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/secret-scanning/17
examples:
- default: &620
+ default: &617
value:
- id: 21
number: 42
@@ -44556,7 +44556,7 @@ paths:
description: Response
content:
application/json:
- schema: &459
+ schema: &456
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -44637,7 +44637,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &460
+ default: &457
value:
group_id: '123'
group_name: Octocat admins
@@ -44692,7 +44692,7 @@ paths:
description: Response
content:
application/json:
- schema: &457
+ schema: &454
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -44729,7 +44729,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &458
+ default: &455
value:
groups:
- group_id: '123'
@@ -46031,7 +46031,7 @@ paths:
application/json:
schema: *22
examples:
- default: &651
+ default: &648
value:
id: 1
account:
@@ -46256,7 +46256,7 @@ paths:
required: true
content:
application/json:
- schema: &652
+ schema: &649
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -47117,7 +47117,7 @@ paths:
application/json:
schema: *376
examples:
- default: &566
+ default: &563
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -48366,7 +48366,7 @@ paths:
parameters:
- *87
- *382
- - &824
+ - &819
name: repo_name
description: repo_name parameter
in: path
@@ -49692,7 +49692,7 @@ paths:
- nuget
- container
- *87
- - &825
+ - &820
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -49733,7 +49733,7 @@ paths:
default: *388
'403': *29
'401': *25
- '400': &827
+ '400': &822
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -51525,7 +51525,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &914
+ properties: &909
id:
type: number
description: The unique identifier of the status update.
@@ -51573,7 +51573,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &915
+ required: &910
- id
- node_id
- created_at
@@ -51787,7 +51787,7 @@ paths:
content:
oneOf:
- *220
- - &583
+ - &580
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -52016,7 +52016,7 @@ paths:
- review_comment
- self
author_association: *221
- auto_merge: &701
+ auto_merge: &698
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -52391,7 +52391,7 @@ paths:
- updated_at
- project_url
examples:
- default: &844
+ default: &839
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52568,7 +52568,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &845
+ items: &840
type: object
properties:
name:
@@ -52604,7 +52604,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &846
+ iteration_configuration: &841
type: object
description: The configuration for iteration fields.
properties:
@@ -52653,7 +52653,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &847
+ single_select_field: &842
summary: Create a single select field
value:
name: Priority
@@ -52680,7 +52680,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &848
+ iteration_field: &843
summary: Create an iteration field
value:
name: Sprint
@@ -52706,7 +52706,7 @@ paths:
application/json:
schema: *409
examples:
- text_field: &849
+ text_field: &844
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -52715,7 +52715,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &850
+ number_field: &845
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -52724,7 +52724,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &851
+ date_field: &846
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -52733,7 +52733,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &852
+ single_select_field: &847
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52767,7 +52767,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &853
+ iteration_field: &848
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -52813,7 +52813,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization
parameters:
- *405
- - &854
+ - &849
name: field_id
description: The unique identifier of the field.
in: path
@@ -52828,7 +52828,7 @@ paths:
application/json:
schema: *409
examples:
- default: &855
+ default: &850
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -53950,7 +53950,7 @@ paths:
parameters:
- *405
- *87
- - &856
+ - &851
name: view_number
description: The number that identifies the project view.
in: path
@@ -54716,7 +54716,7 @@ paths:
description: Response
content:
application/json:
- schema: &467
+ schema: &464
title: Full Repository
description: Full Repository
type: object
@@ -55109,7 +55109,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &588
+ properties: &585
url:
type: string
format: uri
@@ -55125,7 +55125,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &589
+ required: &586
- url
- key
- name
@@ -55214,7 +55214,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &469
+ default: &466
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -55767,7 +55767,7 @@ paths:
- *87
- *17
- *19
- - &723
+ - &720
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -55982,7 +55982,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *87
- - &725
+ - &722
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
@@ -55994,14 +55994,14 @@ paths:
x-multi-segment: true
- *309
- *105
- - &726
+ - &723
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
- - &727
+ - &724
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -56021,7 +56021,7 @@ paths:
description: Response
content:
application/json:
- schema: &728
+ schema: &725
title: Rule Suites
description: Response
type: array
@@ -56076,7 +56076,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &729
+ default: &726
value:
- id: 21
actor_id: 12
@@ -56120,7 +56120,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *87
- - &730
+ - &727
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -56136,7 +56136,7 @@ paths:
description: Response
content:
application/json:
- schema: &731
+ schema: &728
title: Rule Suite
description: Response
type: object
@@ -56235,7 +56235,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &732
+ default: &729
value:
id: 21
actor_id: 12
@@ -56567,7 +56567,7 @@ paths:
- *110
- *19
- *17
- - &734
+ - &731
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -56577,7 +56577,7 @@ paths:
required: false
schema:
type: string
- - &735
+ - &732
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -56790,7 +56790,7 @@ paths:
application/json:
schema:
type: array
- items: &756
+ items: &753
description: A repository security advisory.
type: object
properties:
@@ -57081,7 +57081,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &757
+ default: &754
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -58090,7 +58090,7 @@ paths:
description: Response
content:
application/json:
- schema: &464
+ schema: &461
title: GroupMapping
description: External Groups to be mapped to a team for membership
type: object
@@ -58136,7 +58136,7 @@ paths:
type: string
nullable: true
examples:
- default: &465
+ default: &462
value:
groups:
- group_id: '123'
@@ -58940,13 +58940,6 @@ paths:
does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -58998,8 +58991,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -59012,7 +59003,7 @@ paths:
- updated_at
- url
examples:
- default: &800
+ default: &797
value:
- author:
login: octocat
@@ -59037,8 +59028,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -59148,8 +59137,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -59260,7 +59247,7 @@ paths:
application/json:
schema: *451
examples:
- default: &801
+ default: &798
value:
author:
login: octocat
@@ -59285,8 +59272,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -59341,410 +59326,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - *87
- - *215
- - *453
- - *110
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &454
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *222
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &802
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- headers:
- Link: *47
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: &455
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- - &456
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *455
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- - *456
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: &803
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- - *456
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -59766,9 +59347,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -59811,9 +59392,9 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -59954,7 +59535,7 @@ paths:
description: Response
content:
application/json:
- schema: &461
+ schema: &458
title: Team Membership
description: Team Membership
type: object
@@ -59981,7 +59562,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &804
+ response-if-user-is-a-team-maintainer: &799
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -60044,9 +59625,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- response-if-users-membership-with-team-is-now-pending: &805
+ response-if-users-membership-with-team-is-now-pending: &800
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -60153,14 +59734,14 @@ paths:
parameters:
- *87
- *215
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &806
+ schema: &801
title: Team Repository
description: A team's access to a repository.
type: object
@@ -60731,8 +60312,8 @@ paths:
parameters:
- *87
- *215
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -60779,8 +60360,8 @@ paths:
parameters:
- *87
- *215
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -60813,9 +60394,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *465
+ default: *462
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -60881,7 +60462,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -60926,7 +60507,7 @@ paths:
type: array
items: *312
examples:
- response-if-child-teams-exist: &807
+ response-if-child-teams-exist: &802
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -61080,7 +60661,7 @@ paths:
resources:
type: object
properties:
- core: &466
+ core: &463
title: Rate Limit
type: object
properties:
@@ -61097,21 +60678,21 @@ paths:
- remaining
- reset
- used
- graphql: *466
- search: *466
- code_search: *466
- source_import: *466
- integration_manifest: *466
- code_scanning_upload: *466
- actions_runner_registration: *466
- scim: *466
- dependency_snapshots: *466
- dependency_sbom: *466
- code_scanning_autofix: *466
+ graphql: *463
+ search: *463
+ code_search: *463
+ source_import: *463
+ integration_manifest: *463
+ code_scanning_upload: *463
+ actions_runner_registration: *463
+ scim: *463
+ dependency_snapshots: *463
+ dependency_sbom: *463
+ code_scanning_autofix: *463
required:
- core
- search
- rate: *466
+ rate: *463
required:
- rate
- resources
@@ -61216,14 +60797,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
default-response:
summary: Default response
@@ -61728,7 +61309,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *468
+ '301': *465
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61746,8 +61327,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -62004,10 +61585,10 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
- '307': &470
+ default: *466
+ '307': &467
description: Temporary Redirect
content:
application/json:
@@ -62036,8 +61617,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -62059,7 +61640,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
- '307': *470
+ '307': *467
'404': *6
'409': *118
x-github:
@@ -62083,11 +61664,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- - &487
+ - &484
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -62110,7 +61691,7 @@ paths:
type: integer
artifacts:
type: array
- items: &471
+ items: &468
title: Artifact
description: An artifact
type: object
@@ -62188,7 +61769,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &488
+ default: &485
value:
total_count: 2
artifacts:
@@ -62249,9 +61830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact
parameters:
- - *462
- - *463
- - &472
+ - *459
+ - *460
+ - &469
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -62263,7 +61844,7 @@ paths:
description: Response
content:
application/json:
- schema: *471
+ schema: *468
examples:
default:
value:
@@ -62301,9 +61882,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact
parameters:
- - *462
- - *463
- - *472
+ - *459
+ - *460
+ - *469
responses:
'204':
description: Response
@@ -62327,9 +61908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact
parameters:
- - *462
- - *463
- - *472
+ - *459
+ - *460
+ - *469
- name: archive_format
in: path
required: true
@@ -62343,7 +61924,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': &655
+ '410': &652
description: Gone
content:
application/json:
@@ -62368,14 +61949,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &473
+ schema: &470
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -62408,13 +61989,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *473
+ schema: *470
examples:
selected_actions: *44
responses:
@@ -62443,14 +62024,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &474
+ schema: &471
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -62483,13 +62064,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *474
+ schema: *471
examples:
selected_actions: *46
responses:
@@ -62520,14 +62101,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *475
+ schema: *472
examples:
default:
value:
@@ -62553,11 +62134,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- - &476
+ - &473
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/`. To reference
@@ -62591,7 +62172,7 @@ paths:
description: Response
content:
application/json:
- schema: &477
+ schema: &474
title: Repository actions caches
description: Repository actions caches
type: object
@@ -62633,7 +62214,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &478
+ default: &475
value:
total_count: 1
actions_caches:
@@ -62665,23 +62246,23 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *476
+ - *473
responses:
'200':
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
- default: *478
+ default: *475
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62701,8 +62282,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -62733,9 +62314,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *462
- - *463
- - &479
+ - *459
+ - *460
+ - &476
name: job_id
description: The unique identifier of the job.
in: path
@@ -62747,7 +62328,7 @@ paths:
description: Response
content:
application/json:
- schema: &491
+ schema: &488
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -63054,9 +62635,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *462
- - *463
- - *479
+ - *459
+ - *460
+ - *476
responses:
'302':
description: Response
@@ -63084,9 +62665,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *462
- - *463
- - *479
+ - *459
+ - *460
+ - *476
requestBody:
required: false
content:
@@ -63131,8 +62712,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Status response
@@ -63182,8 +62763,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -63246,8 +62827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -63265,7 +62846,7 @@ paths:
type: integer
secrets:
type: array
- items: &493
+ items: &490
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -63285,7 +62866,7 @@ paths:
- created_at
- updated_at
examples:
- default: &494
+ default: &491
value:
total_count: 2
secrets:
@@ -63318,9 +62899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables
parameters:
- - *462
- - *463
- - *480
+ - *459
+ - *460
+ - *477
- *19
responses:
'200':
@@ -63337,7 +62918,7 @@ paths:
type: integer
variables:
type: array
- items: &497
+ items: &494
title: Actions Variable
type: object
properties:
@@ -63367,7 +62948,7 @@ paths:
- created_at
- updated_at
examples:
- default: &498
+ default: &495
value:
total_count: 2
variables:
@@ -63400,8 +62981,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63410,7 +62991,7 @@ paths:
schema:
type: object
properties:
- enabled: &481
+ enabled: &478
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *60
@@ -63445,8 +63026,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -63457,7 +63038,7 @@ paths:
schema:
type: object
properties:
- enabled: *481
+ enabled: *478
allowed_actions: *60
sha_pinning_required: *61
required:
@@ -63490,14 +63071,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &482
+ schema: &479
type: object
properties:
access_level:
@@ -63515,7 +63096,7 @@ paths:
required:
- access_level
examples:
- default: &483
+ default: &480
value:
access_level: organization
x-github:
@@ -63540,15 +63121,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *482
+ schema: *479
examples:
- default: *483
+ default: *480
responses:
'204':
description: Response
@@ -63572,8 +63153,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63603,8 +63184,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Empty response for successful settings update
@@ -63638,8 +63219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63666,8 +63247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -63701,8 +63282,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63730,8 +63311,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -63762,8 +63343,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63794,8 +63375,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -63827,8 +63408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63857,8 +63438,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Success response
@@ -63898,8 +63479,8 @@ paths:
in: query
schema:
type: string
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -63943,8 +63524,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63976,8 +63557,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -64051,8 +63632,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'201':
description: Response
@@ -64088,8 +63669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'201':
description: Response
@@ -64119,8 +63700,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'200':
@@ -64150,8 +63731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'204':
@@ -64178,8 +63759,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'200': *81
@@ -64204,8 +63785,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
requestBody:
required: true
@@ -64254,8 +63835,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
requestBody:
required: true
@@ -64305,8 +63886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'200': *290
@@ -64336,8 +63917,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
- *291
responses:
@@ -64367,9 +63948,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *462
- - *463
- - &501
+ - *459
+ - *460
+ - &498
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.
@@ -64377,7 +63958,7 @@ paths:
required: false
schema:
type: string
- - &502
+ - &499
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -64385,7 +63966,7 @@ paths:
required: false
schema:
type: string
- - &503
+ - &500
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -64394,7 +63975,7 @@ paths:
required: false
schema:
type: string
- - &504
+ - &501
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
@@ -64421,7 +64002,7 @@ paths:
- pending
- *17
- *19
- - &505
+ - &502
name: created
description: Returns workflow runs created within the given date-time range.
For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -64430,7 +64011,7 @@ paths:
schema:
type: string
format: date-time
- - &484
+ - &481
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -64439,13 +64020,13 @@ paths:
schema:
type: boolean
default: false
- - &506
+ - &503
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &507
+ - &504
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -64468,7 +64049,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &485
+ items: &482
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -64616,7 +64197,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &529
+ properties: &526
id:
type: string
description: SHA for the commit
@@ -64667,7 +64248,7 @@ paths:
- name
- email
nullable: true
- required: &530
+ required: &527
- id
- tree_id
- message
@@ -64714,7 +64295,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &508
+ default: &505
value:
total_count: 1
workflow_runs:
@@ -64950,24 +64531,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *462
- - *463
- - &486
+ - *459
+ - *460
+ - &483
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *484
+ - *481
responses:
'200':
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
- default: &489
+ default: &486
value:
id: 30433642
name: Build
@@ -65208,9 +64789,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'204':
description: Response
@@ -65233,9 +64814,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'200':
description: Response
@@ -65354,9 +64935,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'201':
description: Response
@@ -65389,12 +64970,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
- *17
- *19
- - *487
+ - *484
responses:
'200':
description: Response
@@ -65410,9 +64991,9 @@ paths:
type: integer
artifacts:
type: array
- items: *471
+ items: *468
examples:
- default: *488
+ default: *485
headers:
Link: *47
x-github:
@@ -65436,25 +65017,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *462
- - *463
- - *486
- - &490
+ - *459
+ - *460
+ - *483
+ - &487
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *484
+ - *481
responses:
'200':
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
- default: *489
+ default: *486
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65477,10 +65058,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *462
- - *463
- - *486
- - *490
+ - *459
+ - *460
+ - *483
+ - *487
- *17
- *19
responses:
@@ -65498,9 +65079,9 @@ paths:
type: integer
jobs:
type: array
- items: *491
+ items: *488
examples:
- default: &492
+ default: &489
value:
total_count: 1
jobs:
@@ -65613,10 +65194,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *462
- - *463
- - *486
- - *490
+ - *459
+ - *460
+ - *483
+ - *487
responses:
'302':
description: Response
@@ -65644,9 +65225,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'202':
description: Response
@@ -65679,9 +65260,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: true
content:
@@ -65748,9 +65329,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'202':
description: Response
@@ -65783,9 +65364,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
- 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
@@ -65815,9 +65396,9 @@ paths:
type: integer
jobs:
type: array
- items: *491
+ items: *488
examples:
- default: *492
+ default: *489
headers:
Link: *47
x-github:
@@ -65842,9 +65423,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'302':
description: Response
@@ -65871,9 +65452,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'204':
description: Response
@@ -65900,9 +65481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'200':
description: Response
@@ -65962,7 +65543,7 @@ paths:
items:
type: object
properties:
- type: &621
+ type: &618
type: string
description: The type of reviewer.
enum:
@@ -66047,9 +65628,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: true
content:
@@ -66096,7 +65677,7 @@ paths:
application/json:
schema:
type: array
- items: &606
+ items: &603
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -66202,7 +65783,7 @@ paths:
- created_at
- updated_at
examples:
- default: &607
+ default: &604
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -66258,9 +65839,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: false
content:
@@ -66304,9 +65885,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: false
content:
@@ -66360,9 +65941,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'200':
description: Response
@@ -66499,8 +66080,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -66518,9 +66099,9 @@ paths:
type: integer
secrets:
type: array
- items: *493
+ items: *490
examples:
- default: *494
+ default: *491
headers:
Link: *47
x-github:
@@ -66545,16 +66126,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *495
+ schema: *492
examples:
- default: *496
+ default: *493
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66576,17 +66157,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: &634
+ default: &631
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -66612,8 +66193,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
requestBody:
required: true
@@ -66671,8 +66252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'204':
@@ -66698,9 +66279,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables
parameters:
- - *462
- - *463
- - *480
+ - *459
+ - *460
+ - *477
- *19
responses:
'200':
@@ -66717,9 +66298,9 @@ paths:
type: integer
variables:
type: array
- items: *497
+ items: *494
examples:
- default: *498
+ default: *495
headers:
Link: *47
x-github:
@@ -66742,8 +66323,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -66795,17 +66376,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
responses:
'200':
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &635
+ default: &632
value:
name: USERNAME
value: octocat
@@ -66831,8 +66412,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
requestBody:
required: true
@@ -66875,8 +66456,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
responses:
'204':
@@ -66902,8 +66483,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -66921,7 +66502,7 @@ paths:
type: integer
workflows:
type: array
- items: &499
+ items: &496
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -67028,9 +66609,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow
parameters:
- - *462
- - *463
- - &500
+ - *459
+ - *460
+ - &497
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -67045,7 +66626,7 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
default:
value:
@@ -67078,9 +66659,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'204':
description: Response
@@ -67105,9 +66686,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'204':
description: Response
@@ -67158,9 +66739,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'204':
description: Response
@@ -67187,19 +66768,19 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *462
- - *463
+ - *459
+ - *460
+ - *497
+ - *498
+ - *499
- *500
- *501
+ - *17
+ - *19
- *502
+ - *481
- *503
- *504
- - *17
- - *19
- - *505
- - *484
- - *506
- - *507
responses:
'200':
description: Response
@@ -67215,9 +66796,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *485
+ items: *482
examples:
- default: *508
+ default: *505
headers:
Link: *47
x-github:
@@ -67250,9 +66831,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'200':
description: Response
@@ -67313,8 +66894,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *110
- *17
- *108
@@ -67478,8 +67059,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -67516,8 +67097,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: assignee
in: path
required: true
@@ -67553,8 +67134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -67666,8 +67247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *108
- *109
@@ -67724,7 +67305,7 @@ paths:
initiator:
type: string
examples:
- default: *509
+ default: *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67744,8 +67325,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -67753,7 +67334,7 @@ paths:
application/json:
schema:
type: array
- items: &510
+ items: &507
title: Autolink reference
description: An autolink reference.
type: object
@@ -67807,8 +67388,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -67847,9 +67428,9 @@ paths:
description: response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: &511
+ default: &508
value:
id: 1
key_prefix: TICKET-
@@ -67880,9 +67461,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *462
- - *463
- - &512
+ - *459
+ - *460
+ - &509
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -67894,9 +67475,9 @@ paths:
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: *511
+ default: *508
'404': *6
x-github:
githubCloudOnly: false
@@ -67916,9 +67497,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *462
- - *463
- - *512
+ - *459
+ - *460
+ - *509
responses:
'204':
description: Response
@@ -67942,8 +67523,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response if Dependabot is enabled
@@ -67991,8 +67572,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -68013,8 +67594,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -68034,8 +67615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -68073,7 +67654,7 @@ paths:
- url
protected:
type: boolean
- protection: &514
+ protection: &511
title: Branch Protection
description: Branch Protection
type: object
@@ -68115,7 +67696,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &517
+ enforce_admins: &514
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -68130,7 +67711,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &519
+ required_pull_request_reviews: &516
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -68206,7 +67787,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &516
+ restrictions: &513
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -68483,9 +68064,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch
parameters:
- - *462
- - *463
- - &515
+ - *459
+ - *460
+ - &512
name: branch
description: The name of the branch. Cannot contain wildcard characters. To
use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).
@@ -68499,14 +68080,14 @@ paths:
description: Response
content:
application/json:
- schema: &525
+ schema: &522
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &579
+ commit: &576
title: Commit
description: Commit
type: object
@@ -68540,7 +68121,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &513
+ properties: &510
name:
type: string
example: '"Chris Wanstrath"'
@@ -68556,7 +68137,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *513
+ properties: *510
nullable: true
message:
type: string
@@ -68577,7 +68158,7 @@ paths:
required:
- sha
- url
- verification: &641
+ verification: &638
title: Verification
type: object
properties:
@@ -68647,7 +68228,7 @@ paths:
type: integer
files:
type: array
- items: &592
+ items: &589
title: Diff Entry
description: Diff Entry
type: object
@@ -68731,7 +68312,7 @@ paths:
- self
protected:
type: boolean
- protection: *514
+ protection: *511
protection_url:
type: string
format: uri
@@ -68838,7 +68419,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *468
+ '301': *465
'404': *6
x-github:
githubCloudOnly: false
@@ -68860,15 +68441,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -69062,9 +68643,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -69319,7 +68900,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &522
+ required_status_checks: &519
title: Status Check Policy
description: Status Check Policy
type: object
@@ -69471,7 +69052,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *516
+ restrictions: *513
required_conversation_resolution:
type: object
properties:
@@ -69583,9 +69164,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -69610,17 +69191,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &518
+ default: &515
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -69642,17 +69223,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69671,9 +69252,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -69698,17 +69279,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: &520
+ default: &517
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -69804,9 +69385,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -69904,9 +69485,9 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: *520
+ default: *517
'422': *15
x-github:
githubCloudOnly: false
@@ -69927,9 +69508,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -69956,17 +69537,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &521
+ default: &518
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -69989,17 +69570,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *521
+ default: *518
'404': *6
x-github:
githubCloudOnly: false
@@ -70019,9 +69600,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -70046,17 +69627,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
- default: &523
+ default: &520
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -70082,9 +69663,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70136,9 +69717,9 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
- default: *523
+ default: *520
'404': *6
'422': *15
x-github:
@@ -70160,9 +69741,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -70186,9 +69767,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -70222,9 +69803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70291,9 +69872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70357,9 +69938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
content:
application/json:
@@ -70425,15 +70006,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
default:
value:
@@ -70524,9 +70105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -70549,9 +70130,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -70561,7 +70142,7 @@ paths:
type: array
items: *5
examples:
- default: &524
+ default: &521
value:
- id: 1
slug: octoapp
@@ -70618,9 +70199,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -70654,7 +70235,7 @@ paths:
type: array
items: *5
examples:
- default: *524
+ default: *521
'422': *15
x-github:
githubCloudOnly: false
@@ -70675,9 +70256,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -70711,7 +70292,7 @@ paths:
type: array
items: *5
examples:
- default: *524
+ default: *521
'422': *15
x-github:
githubCloudOnly: false
@@ -70732,9 +70313,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -70768,7 +70349,7 @@ paths:
type: array
items: *5
examples:
- default: *524
+ default: *521
'422': *15
x-github:
githubCloudOnly: false
@@ -70790,9 +70371,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -70822,9 +70403,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70883,9 +70464,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70944,9 +70525,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
content:
application/json:
@@ -71005,9 +70586,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -71041,9 +70622,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71101,9 +70682,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71161,9 +70742,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71223,9 +70804,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71247,7 +70828,7 @@ paths:
description: Response
content:
application/json:
- schema: *525
+ schema: *522
examples:
default:
value:
@@ -71361,8 +70942,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *103
- *104
- *105
@@ -71398,8 +70979,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_request_number
in: path
required: true
@@ -71472,8 +71053,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *103
- *104
- *105
@@ -71513,8 +71094,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_request_number
in: path
required: true
@@ -71584,8 +71165,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_request_number
in: path
required: true
@@ -71656,8 +71237,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_response_id
in: path
required: true
@@ -71690,8 +71271,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -71970,7 +71551,7 @@ paths:
description: Response
content:
application/json:
- schema: &526
+ schema: &523
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -72090,7 +71671,7 @@ paths:
check.
type: array
items: *225
- deployment: &867
+ deployment: &862
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -72370,9 +71951,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run
parameters:
- - *462
- - *463
- - &527
+ - *459
+ - *460
+ - &524
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -72384,9 +71965,9 @@ paths:
description: Response
content:
application/json:
- schema: *526
+ schema: *523
examples:
- default: &528
+ default: &525
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -72486,9 +72067,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run
parameters:
- - *462
- - *463
- - *527
+ - *459
+ - *460
+ - *524
requestBody:
required: true
content:
@@ -72728,9 +72309,9 @@ paths:
description: Response
content:
application/json:
- schema: *526
+ schema: *523
examples:
- default: *528
+ default: *525
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72750,9 +72331,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations
parameters:
- - *462
- - *463
- - *527
+ - *459
+ - *460
+ - *524
- *17
- *19
responses:
@@ -72847,9 +72428,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
parameters:
- - *462
- - *463
- - *527
+ - *459
+ - *460
+ - *524
responses:
'201':
description: Response
@@ -72893,8 +72474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -72916,7 +72497,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &531
+ schema: &528
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -73002,12 +72583,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &898
+ head_commit: &893
title: Simple Commit
description: A commit.
type: object
- properties: *529
- required: *530
+ properties: *526
+ required: *527
latest_check_runs_count:
type: integer
check_runs_url:
@@ -73035,7 +72616,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &532
+ default: &529
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -73326,9 +72907,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73347,8 +72928,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -73657,9 +73238,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite
parameters:
- - *462
- - *463
- - &533
+ - *459
+ - *460
+ - &530
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -73671,9 +73252,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73696,17 +73277,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *462
- - *463
- - *533
- - &585
+ - *459
+ - *460
+ - *530
+ - &582
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &586
+ - &583
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -73745,9 +73326,9 @@ paths:
type: integer
check_runs:
type: array
- items: *526
+ items: *523
examples:
- default: &587
+ default: &584
value:
total_count: 1
check_runs:
@@ -73849,9 +73430,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
parameters:
- - *462
- - *463
- - *533
+ - *459
+ - *460
+ - *530
responses:
'201':
description: Response
@@ -73884,21 +73465,21 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *316
- *317
- *19
- *17
- - &549
+ - &546
name: ref
description: The Git reference for the results you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
in: query
required: false
- schema: *534
- - &550
+ schema: *531
+ - &547
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -73929,7 +73510,7 @@ paths:
be returned.
in: query
required: false
- schema: *535
+ schema: *532
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -73953,7 +73534,7 @@ paths:
updated_at: *135
url: *132
html_url: *133
- instances_url: *536
+ instances_url: *533
state: *113
fixed_at: *137
dismissed_by:
@@ -73964,11 +73545,11 @@ paths:
required: *21
nullable: true
dismissed_at: *136
- dismissed_reason: *537
- dismissed_comment: *538
- rule: *539
- tool: *540
- most_recent_instance: *541
+ dismissed_reason: *534
+ dismissed_comment: *535
+ rule: *536
+ tool: *537
+ most_recent_instance: *538
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -74094,7 +73675,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &542
+ '403': &539
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -74121,9 +73702,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *462
- - *463
- - &543
+ - *459
+ - *460
+ - &540
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -74137,7 +73718,7 @@ paths:
description: Response
content:
application/json:
- schema: &544
+ schema: &541
type: object
properties:
number: *127
@@ -74145,7 +73726,7 @@ paths:
updated_at: *135
url: *132
html_url: *133
- instances_url: *536
+ instances_url: *533
state: *113
fixed_at: *137
dismissed_by:
@@ -74156,8 +73737,8 @@ paths:
required: *21
nullable: true
dismissed_at: *136
- dismissed_reason: *537
- dismissed_comment: *538
+ dismissed_reason: *534
+ dismissed_comment: *535
rule:
type: object
properties:
@@ -74211,8 +73792,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *540
- most_recent_instance: *541
+ tool: *537
+ most_recent_instance: *538
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -74311,7 +73892,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74331,9 +73912,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
requestBody:
required: true
content:
@@ -74348,8 +73929,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *537
- dismissed_comment: *538
+ dismissed_reason: *534
+ dismissed_comment: *535
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -74377,7 +73958,7 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -74453,7 +74034,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &548
+ '403': &545
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -74480,15 +74061,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
responses:
'200':
description: Response
content:
application/json:
- schema: &545
+ schema: &542
type: object
properties:
status:
@@ -74514,13 +74095,13 @@ paths:
- description
- started_at
examples:
- default: &546
+ default: &543
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &547
+ '400': &544
description: Bad Request
content:
application/json:
@@ -74531,7 +74112,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': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74556,29 +74137,29 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
responses:
'200':
description: OK
content:
application/json:
- schema: *545
+ schema: *542
examples:
- default: *546
+ default: *543
'202':
description: Accepted
content:
application/json:
- schema: *545
+ schema: *542
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *547
+ '400': *544
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -74610,9 +74191,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
requestBody:
required: false
content:
@@ -74657,8 +74238,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *547
- '403': *548
+ '400': *544
+ '403': *545
'404': *6
'422':
description: Unprocessable Entity
@@ -74682,13 +74263,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
- *19
- *17
- - *549
- - *550
+ - *546
+ - *547
responses:
'200':
description: Response
@@ -74699,10 +74280,10 @@ paths:
items:
type: object
properties:
- ref: *534
- analysis_key: *551
- environment: *552
- category: *553
+ ref: *531
+ analysis_key: *548
+ environment: *549
+ category: *550
state:
type: string
description: State of a code scanning alert instance.
@@ -74717,7 +74298,7 @@ paths:
properties:
text:
type: string
- location: *554
+ location: *551
html_url:
type: string
classifications:
@@ -74725,7 +74306,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: *555
+ items: *552
examples:
default:
value:
@@ -74764,7 +74345,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74798,25 +74379,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *316
- *317
- *19
- *17
- - *550
+ - *547
- name: ref
in: query
description: The Git reference for the analyses you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *534
+ schema: *531
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &556
+ schema: &553
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -74837,23 +74418,23 @@ paths:
application/json:
schema:
type: array
- items: &557
+ items: &554
type: object
properties:
- ref: *534
- commit_sha: &565
+ ref: *531
+ commit_sha: &562
description: The SHA of the commit to which the analysis you
are uploading relates.
type: string
minLength: 40
maxLength: 40
pattern: "^[0-9a-fA-F]+$"
- analysis_key: *551
+ analysis_key: *548
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *553
+ category: *550
error:
type: string
example: error reading field xyz
@@ -74877,8 +74458,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *556
- tool: *540
+ sarif_id: *553
+ tool: *537
deletable:
type: boolean
warning:
@@ -74939,7 +74520,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74975,8 +74556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -74989,7 +74570,7 @@ paths:
description: Response
content:
application/json:
- schema: *557
+ schema: *554
examples:
response:
summary: application/json response
@@ -75043,7 +74624,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *542
+ '403': *539
'404': *6
'422':
description: Response if analysis could not be processed
@@ -75130,8 +74711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -75184,7 +74765,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': *548
+ '403': *545
'404': *6
'503': *195
x-github:
@@ -75206,8 +74787,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -75215,7 +74796,7 @@ paths:
application/json:
schema:
type: array
- items: &558
+ items: &555
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -75326,7 +74907,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': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -75355,8 +74936,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: language
in: path
description: The language of the CodeQL database.
@@ -75368,7 +74949,7 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
default:
value:
@@ -75400,9 +74981,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': &594
+ '302': &591
description: Found
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -75424,8 +75005,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: language
in: path
description: The language of the CodeQL database.
@@ -75435,7 +75016,7 @@ paths:
responses:
'204':
description: Response
- '403': *548
+ '403': *545
'404': *6
'503': *195
x-github:
@@ -75463,8 +75044,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -75473,7 +75054,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &559
+ language: &556
type: string
description: The language targeted by the CodeQL query
enum:
@@ -75553,7 +75134,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &563
+ schema: &560
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -75563,7 +75144,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *119
actor: *4
- query_language: *559
+ query_language: *556
query_pack_url:
type: string
description: The download url for the query pack.
@@ -75610,7 +75191,7 @@ paths:
items:
type: object
properties:
- repository: &560
+ repository: &557
title: Repository Identifier
description: Repository Identifier
type: object
@@ -75646,7 +75227,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &564
+ analysis_status: &561
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -75678,7 +75259,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &561
+ access_mismatch_repos: &558
type: object
properties:
repository_count:
@@ -75692,7 +75273,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: *560
+ items: *557
required:
- repository_count
- repositories
@@ -75714,8 +75295,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *561
- over_limit_repos: *561
+ no_codeql_db_repos: *558
+ over_limit_repos: *558
required:
- access_mismatch_repos
- not_found_repos
@@ -75731,7 +75312,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &562
+ value: &559
summary: Default response
value:
id: 1
@@ -75877,10 +75458,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *562
+ value: *559
repository_lists:
summary: Response for a successful variant analysis submission
- value: *562
+ value: *559
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -75908,8 +75489,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -75921,9 +75502,9 @@ paths:
description: Response
content:
application/json:
- schema: *563
+ schema: *560
examples:
- default: *562
+ default: *559
'404': *6
'503': *195
x-github:
@@ -75946,7 +75527,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis
parameters:
- - *462
+ - *459
- name: repo
in: path
description: The name of the controller repository.
@@ -75981,7 +75562,7 @@ paths:
type: object
properties:
repository: *119
- analysis_status: *564
+ analysis_status: *561
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -76106,8 +75687,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -76192,7 +75773,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -76213,8 +75794,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -76306,7 +75887,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *548
+ '403': *545
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -76377,8 +75958,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -76386,7 +75967,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *565
+ commit_sha: *562
ref:
type: string
description: |-
@@ -76444,7 +76025,7 @@ paths:
schema:
type: object
properties:
- id: *556
+ id: *553
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -76458,7 +76039,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': *548
+ '403': *545
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -76481,8 +76062,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -76528,7 +76109,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': *542
+ '403': *539
'404':
description: Not Found if the sarif id does not match any upload
'503': *195
@@ -76553,8 +76134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -76635,8 +76216,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -76756,8 +76337,8 @@ paths:
parameters:
- *17
- *19
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -77071,8 +76652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -77137,7 +76718,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -77145,7 +76726,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'400': *14
'401': *25
'403': *29
@@ -77174,8 +76755,8 @@ paths:
parameters:
- *17
- *19
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -77239,8 +76820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -77275,14 +76856,14 @@ paths:
type: integer
machines:
type: array
- items: &814
+ items: &809
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *567
- required: *568
+ properties: *564
+ required: *565
examples:
- default: &815
+ default: &810
value:
total_count: 2
machines:
@@ -77322,8 +76903,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -77407,8 +76988,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -77474,8 +77055,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -77493,7 +77074,7 @@ paths:
type: integer
secrets:
type: array
- items: &572
+ items: &569
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -77513,7 +77094,7 @@ paths:
- created_at
- updated_at
examples:
- default: *569
+ default: *566
headers:
Link: *47
x-github:
@@ -77536,16 +77117,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *570
+ schema: *567
examples:
- default: *571
+ default: *568
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -77565,17 +77146,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *572
+ schema: *569
examples:
- default: *573
+ default: *570
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -77595,8 +77176,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
requestBody:
required: true
@@ -77649,8 +77230,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'204':
@@ -77679,8 +77260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -77722,7 +77303,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &574
+ properties: &571
login:
type: string
example: octocat
@@ -77815,7 +77396,7 @@ paths:
user_view_type:
type: string
example: public
- required: &575
+ required: &572
- avatar_url
- events_url
- followers_url
@@ -77889,8 +77470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
responses:
'204':
@@ -77937,8 +77518,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
requestBody:
required: false
@@ -77965,7 +77546,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &654
+ schema: &651
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -78194,8 +77775,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
responses:
'204':
@@ -78227,8 +77808,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
responses:
'200':
@@ -78249,8 +77830,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *574
- required: *575
+ properties: *571
+ required: *572
nullable: true
required:
- permission
@@ -78305,8 +77886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -78316,7 +77897,7 @@ paths:
application/json:
schema:
type: array
- items: &576
+ items: &573
title: Commit Comment
description: Commit Comment
type: object
@@ -78374,7 +77955,7 @@ paths:
- created_at
- updated_at
examples:
- default: &581
+ default: &578
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78433,17 +78014,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'200':
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: &582
+ default: &579
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78500,8 +78081,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -78524,7 +78105,7 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
default:
value:
@@ -78575,8 +78156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'204':
@@ -78598,8 +78179,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -78626,7 +78207,7 @@ paths:
application/json:
schema:
type: array
- items: &577
+ items: &574
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -78669,7 +78250,7 @@ paths:
- content
- created_at
examples:
- default: &658
+ default: &655
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78714,8 +78295,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -78748,9 +78329,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: &578
+ default: &575
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78779,9 +78360,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -78803,10 +78384,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- - &659
+ - &656
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -78861,8 +78442,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -78918,9 +78499,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *576
examples:
- default: &708
+ default: &705
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -79014,9 +78595,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit
parameters:
- - *462
- - *463
- - &580
+ - *459
+ - *460
+ - &577
name: commit_sha
description: The SHA of the commit.
in: path
@@ -79088,9 +78669,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
- *17
- *19
responses:
@@ -79100,9 +78681,9 @@ paths:
application/json:
schema:
type: array
- items: *576
+ items: *573
examples:
- default: *581
+ default: *578
headers:
Link: *47
x-github:
@@ -79130,9 +78711,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
requestBody:
required: true
content:
@@ -79167,9 +78748,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *582
+ default: *579
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -79197,9 +78778,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
- *17
- *19
responses:
@@ -79209,9 +78790,9 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *580
examples:
- default: &700
+ default: &697
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -79748,11 +79329,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *19
- *17
- - &584
+ - &581
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)"
@@ -79767,9 +79348,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: &685
+ default: &682
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -79882,11 +79463,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *462
- - *463
- - *584
- - *585
- - *586
+ - *459
+ - *460
+ - *581
+ - *582
+ - *583
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -79920,9 +79501,9 @@ paths:
type: integer
check_runs:
type: array
- items: *526
+ items: *523
examples:
- default: *587
+ default: *584
headers:
Link: *47
x-github:
@@ -79947,9 +79528,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *462
- - *463
- - *584
+ - *459
+ - *460
+ - *581
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -79957,7 +79538,7 @@ paths:
schema:
type: integer
example: 1
- - *585
+ - *582
- *17
- *19
responses:
@@ -79975,7 +79556,7 @@ paths:
type: integer
check_suites:
type: array
- items: *531
+ items: *528
examples:
default:
value:
@@ -80175,9 +79756,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *462
- - *463
- - *584
+ - *459
+ - *460
+ - *581
- *17
- *19
responses:
@@ -80375,9 +79956,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *462
- - *463
- - *584
+ - *459
+ - *460
+ - *581
- *17
- *19
responses:
@@ -80387,7 +79968,7 @@ paths:
application/json:
schema:
type: array
- items: &761
+ items: &758
title: Status
description: The status of a commit.
type: object
@@ -80468,7 +80049,7 @@ paths:
site_admin: false
headers:
Link: *47
- '301': *468
+ '301': *465
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80496,8 +80077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -80526,20 +80107,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *588
- required: *589
+ properties: *585
+ required: *586
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &590
+ properties: &587
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &591
+ required: &588
- url
- html_url
nullable: true
@@ -80553,26 +80134,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
readme:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
required:
- code_of_conduct
@@ -80699,8 +80280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *19
- *17
- name: basehead
@@ -80743,8 +80324,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *579
- merge_base_commit: *579
+ base_commit: *576
+ merge_base_commit: *576
status:
type: string
enum:
@@ -80764,10 +80345,10 @@ paths:
example: 6
commits:
type: array
- items: *579
+ items: *576
files:
type: array
- items: *592
+ items: *589
required:
- url
- html_url
@@ -81053,8 +80634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: path
description: path parameter
in: path
@@ -81197,7 +80778,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &593
+ response-if-content-is-a-file: &590
summary: Response if content is a file
value:
type: file
@@ -81329,7 +80910,7 @@ paths:
- size
- type
- url
- - &713
+ - &710
title: Content File
description: Content File
type: object
@@ -81530,7 +81111,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *593
+ response-if-content-is-a-file: *590
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -81599,7 +81180,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *594
+ '302': *591
'304': *37
x-github:
githubCloudOnly: false
@@ -81622,8 +81203,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: path
description: path parameter
in: path
@@ -81716,7 +81297,7 @@ paths:
description: Response
content:
application/json:
- schema: &595
+ schema: &592
title: File Commit
description: File Commit
type: object
@@ -81868,7 +81449,7 @@ paths:
description: Response
content:
application/json:
- schema: *595
+ schema: *592
examples:
example-for-creating-a-file:
value:
@@ -81922,7 +81503,7 @@ paths:
schema:
oneOf:
- *3
- - &636
+ - &633
description: Repository rule violation was detected
type: object
properties:
@@ -81943,7 +81524,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &753
+ placeholder_id: &750
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -81975,8 +81556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: path
description: path parameter
in: path
@@ -82037,7 +81618,7 @@ paths:
description: Response
content:
application/json:
- schema: *595
+ schema: *592
examples:
default:
value:
@@ -82092,8 +81673,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -82216,8 +81797,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *332
- *333
- *334
@@ -82229,7 +81810,7 @@ paths:
schema:
type: string
- *336
- - *596
+ - *593
- *337
- *338
- *110
@@ -82250,7 +81831,7 @@ paths:
application/json:
schema:
type: array
- items: &600
+ items: &597
type: object
description: A Dependabot alert.
properties:
@@ -82296,7 +81877,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *597
+ security_advisory: *594
security_vulnerability: *131
url: *132
html_url: *133
@@ -82327,8 +81908,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *137
- auto_dismissed_at: *598
- dismissal_request: *599
+ auto_dismissed_at: *595
+ dismissal_request: *596
required:
- number
- state
@@ -82558,9 +82139,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *462
- - *463
- - &601
+ - *459
+ - *460
+ - &598
name: alert_number
in: path
description: |-
@@ -82575,7 +82156,7 @@ paths:
description: Response
content:
application/json:
- schema: *600
+ schema: *597
examples:
default:
value:
@@ -82688,9 +82269,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *462
- - *463
- - *601
+ - *459
+ - *460
+ - *598
requestBody:
required: true
content:
@@ -82735,7 +82316,7 @@ paths:
description: Response
content:
application/json:
- schema: *600
+ schema: *597
examples:
default:
value:
@@ -82864,8 +82445,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -82883,7 +82464,7 @@ paths:
type: integer
secrets:
type: array
- items: &604
+ items: &601
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -82936,16 +82517,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *602
+ schema: *599
examples:
- default: *603
+ default: *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82965,15 +82546,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
default:
value:
@@ -82999,8 +82580,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
requestBody:
required: true
@@ -83053,8 +82634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'204':
@@ -83077,8 +82658,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -83238,8 +82819,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -83478,8 +83059,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -83554,7 +83135,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &605
+ metadata: &602
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -83587,7 +83168,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *605
+ metadata: *602
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -83600,7 +83181,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *605
+ metadata: *602
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -83729,8 +83310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -83770,9 +83351,9 @@ paths:
application/json:
schema:
type: array
- items: *606
+ items: *603
examples:
- default: *607
+ default: *604
headers:
Link: *47
x-github:
@@ -83838,8 +83419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -83920,7 +83501,7 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
simple-example:
summary: Simple example
@@ -83993,9 +83574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment
parameters:
- - *462
- - *463
- - &608
+ - *459
+ - *460
+ - &605
name: deployment_id
description: deployment_id parameter
in: path
@@ -84007,7 +83588,7 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
default:
value:
@@ -84072,9 +83653,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
responses:
'204':
description: Response
@@ -84096,9 +83677,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
- *17
- *19
responses:
@@ -84108,7 +83689,7 @@ paths:
application/json:
schema:
type: array
- items: &609
+ items: &606
title: Deployment Status
description: The status of a deployment.
type: object
@@ -84269,9 +83850,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
requestBody:
required: true
content:
@@ -84346,9 +83927,9 @@ paths:
description: Response
content:
application/json:
- schema: *609
+ schema: *606
examples:
- default: &610
+ default: &607
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -84404,9 +83985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
- name: status_id
in: path
required: true
@@ -84417,9 +83998,9 @@ paths:
description: Response
content:
application/json:
- schema: *609
+ schema: *606
examples:
- default: *610
+ default: *607
'404': *6
x-github:
githubCloudOnly: false
@@ -84446,12 +84027,12 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
+ - *608
+ - *609
+ - *610
- *611
- - *612
- - *613
- - *614
- *17
- *19
responses:
@@ -84461,9 +84042,9 @@ paths:
application/json:
schema:
type: array
- items: *615
+ items: *612
examples:
- default: *616
+ default: *613
'404': *6
'403': *29
'500': *40
@@ -84487,8 +84068,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84500,7 +84081,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *615
+ schema: *612
examples:
default:
value:
@@ -84556,8 +84137,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84616,12 +84197,12 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
+ - *608
+ - *609
+ - *610
- *611
- - *612
- - *613
- - *614
- *17
- *19
responses:
@@ -84631,9 +84212,9 @@ paths:
application/json:
schema:
type: array
- items: *617
+ items: *614
examples:
- default: *618
+ default: *615
'404': *6
'403': *29
'500': *40
@@ -84657,8 +84238,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84670,7 +84251,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *617
+ schema: *614
examples:
default:
value:
@@ -84721,8 +84302,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84760,7 +84341,7 @@ paths:
description: The created dismissal request.
content:
application/json:
- schema: *617
+ schema: *614
examples:
default:
value:
@@ -84811,8 +84392,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84883,8 +84464,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84917,8 +84498,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *103
- *104
- *105
@@ -84932,9 +84513,9 @@ paths:
application/json:
schema:
type: array
- items: *619
+ items: *616
examples:
- default: *620
+ default: *617
'404': *6
'403': *29
'500': *40
@@ -84959,8 +84540,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84972,7 +84553,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *619
+ schema: *616
examples:
default:
value:
@@ -85030,8 +84611,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -85100,8 +84681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -85158,8 +84739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -85176,7 +84757,7 @@ paths:
type: integer
environments:
type: array
- items: &622
+ items: &619
title: Environment
description: Details of a deployment environment
type: object
@@ -85228,7 +84809,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &624
+ wait_timer: &621
type: integer
example: 30
description: The amount of time to delay a job after
@@ -85265,7 +84846,7 @@ paths:
items:
type: object
properties:
- type: *621
+ type: *618
reviewer:
anyOf:
- *4
@@ -85289,7 +84870,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &625
+ deployment_branch_policy: &622
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -85405,9 +84986,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment
parameters:
- - *462
- - *463
- - &623
+ - *459
+ - *460
+ - &620
name: environment_name
in: path
required: true
@@ -85420,9 +85001,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: &626
+ default: &623
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -85506,9 +85087,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
requestBody:
required: false
content:
@@ -85517,7 +85098,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *624
+ wait_timer: *621
prevent_self_review:
type: boolean
example: false
@@ -85534,13 +85115,13 @@ paths:
items:
type: object
properties:
- type: *621
+ type: *618
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *625
+ deployment_branch_policy: *622
additionalProperties: false
examples:
default:
@@ -85560,9 +85141,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: *626
+ default: *623
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -85586,9 +85167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
responses:
'204':
description: Default response
@@ -85613,9 +85194,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *17
- *19
responses:
@@ -85633,7 +85214,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &627
+ items: &624
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -85690,9 +85271,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
requestBody:
required: true
content:
@@ -85738,9 +85319,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- example-wildcard: &628
+ example-wildcard: &625
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -85782,10 +85363,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
- - &629
+ - *459
+ - *460
+ - *620
+ - &626
name: branch_policy_id
in: path
required: true
@@ -85797,9 +85378,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *628
+ default: *625
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85818,10 +85399,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
- - *629
+ - *459
+ - *460
+ - *620
+ - *626
requestBody:
required: true
content:
@@ -85849,9 +85430,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *628
+ default: *625
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85870,10 +85451,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
- - *629
+ - *459
+ - *460
+ - *620
+ - *626
responses:
'204':
description: Response
@@ -85898,9 +85479,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *623
- - *463
- - *462
+ - *620
+ - *460
+ - *459
responses:
'200':
description: List of deployment protection rules
@@ -85916,7 +85497,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &630
+ items: &627
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -85935,7 +85516,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &631
+ app: &628
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -86034,9 +85615,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *623
- - *463
- - *462
+ - *620
+ - *460
+ - *459
requestBody:
content:
application/json:
@@ -86057,9 +85638,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *630
+ schema: *627
examples:
- default: &632
+ default: &629
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -86094,9 +85675,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *623
- - *463
- - *462
+ - *620
+ - *460
+ - *459
- *19
- *17
responses:
@@ -86115,7 +85696,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *631
+ items: *628
examples:
default:
value:
@@ -86150,10 +85731,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *462
- - *463
- - *623
- - &633
+ - *459
+ - *460
+ - *620
+ - &630
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -86165,9 +85746,9 @@ paths:
description: Response
content:
application/json:
- schema: *630
+ schema: *627
examples:
- default: *632
+ default: *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86188,10 +85769,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *623
- - *463
- - *462
- - *633
+ - *620
+ - *460
+ - *459
+ - *630
responses:
'204':
description: Response
@@ -86217,9 +85798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *17
- *19
responses:
@@ -86237,9 +85818,9 @@ paths:
type: integer
secrets:
type: array
- items: *493
+ items: *490
examples:
- default: *494
+ default: *491
headers:
Link: *47
x-github:
@@ -86264,17 +85845,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
responses:
'200':
description: Response
content:
application/json:
- schema: *495
+ schema: *492
examples:
- default: *496
+ default: *493
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86296,18 +85877,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: *634
+ default: *631
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86329,9 +85910,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *293
requestBody:
required: true
@@ -86389,9 +85970,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *293
responses:
'204':
@@ -86417,10 +85998,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables
parameters:
- - *462
- - *463
- - *623
- - *480
+ - *459
+ - *460
+ - *620
+ - *477
- *19
responses:
'200':
@@ -86437,9 +86018,9 @@ paths:
type: integer
variables:
type: array
- items: *497
+ items: *494
examples:
- default: *498
+ default: *495
headers:
Link: *47
x-github:
@@ -86462,9 +86043,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
requestBody:
required: true
content:
@@ -86516,18 +86097,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *296
responses:
'200':
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *635
+ default: *632
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86548,10 +86129,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
- - *623
+ - *620
requestBody:
required: true
content:
@@ -86593,10 +86174,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
- - *623
+ - *620
responses:
'204':
description: Response
@@ -86618,8 +86199,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -86687,8 +86268,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -86847,8 +86428,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -86880,9 +86461,9 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
'400': *14
'422': *15
'403': *29
@@ -86903,8 +86484,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -86964,7 +86545,7 @@ paths:
schema:
oneOf:
- *258
- - *636
+ - *633
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86989,8 +86570,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: file_sha
in: path
required: true
@@ -87089,8 +86670,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -87199,7 +86780,7 @@ paths:
description: Response
content:
application/json:
- schema: &637
+ schema: &634
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -87413,15 +86994,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
responses:
'200':
description: Response
content:
application/json:
- schema: *637
+ schema: *634
examples:
default:
value:
@@ -87477,9 +87058,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references
parameters:
- - *462
- - *463
- - &638
+ - *459
+ - *460
+ - &635
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.
@@ -87496,7 +87077,7 @@ paths:
application/json:
schema:
type: array
- items: &639
+ items: &636
title: Git Reference
description: Git references within a repository
type: object
@@ -87571,17 +87152,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference
parameters:
- - *462
- - *463
- - *638
+ - *459
+ - *460
+ - *635
responses:
'200':
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: &640
+ default: &637
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -87610,8 +87191,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -87640,9 +87221,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: *640
+ default: *637
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -87668,9 +87249,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference
parameters:
- - *462
- - *463
- - *638
+ - *459
+ - *460
+ - *635
requestBody:
required: true
content:
@@ -87699,9 +87280,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: *640
+ default: *637
'422': *15
'409': *118
x-github:
@@ -87719,9 +87300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference
parameters:
- - *462
- - *463
- - *638
+ - *459
+ - *460
+ - *635
responses:
'204':
description: Response
@@ -87776,8 +87357,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -87844,7 +87425,7 @@ paths:
description: Response
content:
application/json:
- schema: &642
+ schema: &639
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -87895,7 +87476,7 @@ paths:
- sha
- type
- url
- verification: *641
+ verification: *638
required:
- sha
- url
@@ -87905,7 +87486,7 @@ paths:
- tag
- message
examples:
- default: &643
+ default: &640
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -87978,8 +87559,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tag_sha
in: path
required: true
@@ -87990,9 +87571,9 @@ paths:
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: *643
+ default: *640
'404': *6
'409': *118
x-github:
@@ -88016,8 +87597,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -88090,7 +87671,7 @@ paths:
description: Response
content:
application/json:
- schema: &644
+ schema: &641
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -88186,8 +87767,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -88210,7 +87791,7 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
default-response:
summary: Default response
@@ -88269,8 +87850,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -88280,7 +87861,7 @@ paths:
application/json:
schema:
type: array
- items: &645
+ items: &642
title: Webhook
description: Webhooks for repositories.
type: object
@@ -88334,7 +87915,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &906
+ last_response: &901
title: Hook Response
type: object
properties:
@@ -88408,8 +87989,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -88461,9 +88042,9 @@ paths:
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
- default: &646
+ default: &643
value:
type: Repository
id: 12345678
@@ -88511,17 +88092,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'200':
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
- default: *646
+ default: *643
'404': *6
x-github:
githubCloudOnly: false
@@ -88541,8 +88122,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
requestBody:
required: true
@@ -88588,9 +88169,9 @@ paths:
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
- default: *646
+ default: *643
'422': *15
'404': *6
x-github:
@@ -88611,8 +88192,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'204':
@@ -88637,8 +88218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'200':
@@ -88666,8 +88247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
requestBody:
required: false
@@ -88712,8 +88293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
- *17
- *349
@@ -88745,8 +88326,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
- *16
responses:
@@ -88775,8 +88356,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
- *16
responses:
@@ -88800,8 +88381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'204':
@@ -88827,8 +88408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'204':
@@ -88852,8 +88433,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response if immutable releases are enabled
@@ -88899,8 +88480,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'409': *118
@@ -88920,8 +88501,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'409': *118
@@ -88978,14 +88559,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &647
+ schema: &644
title: Import
description: A repository import from an external source.
type: object
@@ -89084,7 +88665,7 @@ paths:
- html_url
- authors_url
examples:
- default: &650
+ default: &647
value:
vcs: subversion
use_lfs: true
@@ -89100,7 +88681,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': &648
+ '503': &645
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -89129,8 +88710,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -89178,7 +88759,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
default:
value:
@@ -89203,7 +88784,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89231,8 +88812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -89281,7 +88862,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
example-1:
summary: Example 1
@@ -89329,7 +88910,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': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89352,12 +88933,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89383,9 +88964,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors
parameters:
- - *462
- - *463
- - &836
+ - *459
+ - *460
+ - &831
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -89399,7 +88980,7 @@ paths:
application/json:
schema:
type: array
- items: &649
+ items: &646
title: Porter Author
description: Porter Author
type: object
@@ -89453,7 +89034,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': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89478,8 +89059,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: author_id
in: path
required: true
@@ -89509,7 +89090,7 @@ paths:
description: Response
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
value:
@@ -89522,7 +89103,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89546,8 +89127,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -89588,7 +89169,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89616,8 +89197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -89644,11 +89225,11 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
- default: *650
+ default: *647
'422': *15
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89671,8 +89252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -89680,8 +89261,8 @@ paths:
application/json:
schema: *22
examples:
- default: *651
- '301': *468
+ default: *648
+ '301': *465
'404': *6
x-github:
githubCloudOnly: false
@@ -89701,8 +89282,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -89715,7 +89296,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &653
+ default: &650
value:
limit: collaborators_only
origin: repository
@@ -89740,13 +89321,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *652
+ schema: *649
examples:
default:
summary: Example request body
@@ -89760,7 +89341,7 @@ paths:
application/json:
schema: *366
examples:
- default: *653
+ default: *650
'409':
description: Response
x-github:
@@ -89782,8 +89363,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -89806,8 +89387,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -89817,9 +89398,9 @@ paths:
application/json:
schema:
type: array
- items: *654
+ items: *651
examples:
- default: &829
+ default: &824
value:
- id: 1
repository:
@@ -89950,8 +89531,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *370
requestBody:
required: false
@@ -89981,7 +89562,7 @@ paths:
description: Response
content:
application/json:
- schema: *654
+ schema: *651
examples:
default:
value:
@@ -90112,8 +89693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *370
responses:
'204':
@@ -90145,8 +89726,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -90219,7 +89800,7 @@ paths:
type: array
items: *220
examples:
- default: &666
+ default: &663
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -90367,7 +89948,7 @@ paths:
state_reason: completed
headers:
Link: *47
- '301': *468
+ '301': *465
'422': *15
'404': *6
x-github:
@@ -90396,8 +89977,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -90481,7 +90062,7 @@ paths:
application/json:
schema: *220
examples:
- default: &663
+ default: &660
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -90637,7 +90218,7 @@ paths:
'422': *15
'503': *195
'404': *6
- '410': *655
+ '410': *652
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -90665,8 +90246,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *244
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -90687,9 +90268,9 @@ paths:
application/json:
schema:
type: array
- items: *656
+ items: *653
examples:
- default: &665
+ default: &662
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90747,17 +90328,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'200':
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: &657
+ default: &654
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90811,8 +90392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -90835,9 +90416,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: *657
+ default: *654
'422': *15
x-github:
githubCloudOnly: false
@@ -90855,8 +90436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'204':
@@ -90877,8 +90458,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -90905,9 +90486,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
@@ -90928,8 +90509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -90962,16 +90543,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -90993,10 +90574,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- - *659
+ - *656
responses:
'204':
description: Response
@@ -91016,8 +90597,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -91027,7 +90608,7 @@ paths:
application/json:
schema:
type: array
- items: &662
+ items: &659
title: Issue Event
description: Issue Event
type: object
@@ -91070,8 +90651,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *660
- required: *661
+ properties: *657
+ required: *658
nullable: true
label:
title: Issue Event Label
@@ -91378,8 +90959,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: event_id
in: path
required: true
@@ -91390,7 +90971,7 @@ paths:
description: Response
content:
application/json:
- schema: *662
+ schema: *659
examples:
default:
value:
@@ -91582,7 +91163,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *655
+ '410': *652
'403': *29
x-github:
githubCloudOnly: false
@@ -91616,9 +91197,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue
parameters:
- - *462
- - *463
- - &664
+ - *459
+ - *460
+ - &661
name: issue_number
description: The number that identifies the issue.
in: path
@@ -91632,10 +91213,10 @@ paths:
application/json:
schema: *220
examples:
- default: *663
- '301': *468
+ default: *660
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
'304': *37
x-github:
githubCloudOnly: false
@@ -91660,9 +91241,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -91768,13 +91349,13 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
'422': *15
'503': *195
'403': *29
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91792,9 +91373,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -91822,7 +91403,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91838,9 +91419,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
content:
application/json:
@@ -91867,7 +91448,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91889,9 +91470,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: assignee
in: path
required: true
@@ -91931,9 +91512,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *227
- *17
- *19
@@ -91944,13 +91525,13 @@ paths:
application/json:
schema:
type: array
- items: *656
+ items: *653
examples:
- default: *665
+ default: *662
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91979,9 +91560,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -92003,16 +91584,16 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: *657
+ default: *654
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *655
+ '410': *652
'422': *15
'404': *6
x-github:
@@ -92040,9 +91621,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -92054,12 +91635,12 @@ paths:
type: array
items: *220
examples:
- default: *666
+ default: *663
headers:
Link: *47
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92087,9 +91668,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -92113,15 +91694,15 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *468
+ '301': *465
'403': *29
- '410': *655
+ '410': *652
'422': *15
'404': *6
x-github:
@@ -92152,9 +91733,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -92168,13 +91749,13 @@ paths:
application/json:
schema: *220
examples:
- default: *663
- '301': *468
+ default: *660
+ '301': *465
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *655
+ '410': *652
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -92200,9 +91781,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -92214,12 +91795,12 @@ paths:
type: array
items: *220
examples:
- default: *666
+ default: *663
headers:
Link: *47
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92236,9 +91817,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -92252,7 +91833,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &668
+ - &665
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -92306,7 +91887,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &669
+ - &666
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -92442,7 +92023,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &670
+ - &667
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -92493,7 +92074,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &671
+ - &668
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -92544,7 +92125,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &672
+ - &669
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -92598,7 +92179,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &673
+ - &670
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -92645,7 +92226,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &674
+ - &671
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -92692,7 +92273,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &675
+ - &672
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -92752,7 +92333,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &676
+ - &673
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -92800,7 +92381,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &677
+ - &674
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -92866,7 +92447,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &678
+ - &675
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -92932,7 +92513,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &679
+ - &676
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -92998,7 +92579,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &680
+ - &677
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -93089,7 +92670,7 @@ paths:
color: red
headers:
Link: *47
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93106,9 +92687,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -93120,7 +92701,7 @@ paths:
type: array
items: *219
examples:
- default: &667
+ default: &664
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -93138,9 +92719,9 @@ paths:
default: false
headers:
Link: *47
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93157,9 +92738,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -93220,10 +92801,10 @@ paths:
type: array
items: *219
examples:
- default: *667
- '301': *468
+ default: *664
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
'422': *15
x-github:
githubCloudOnly: false
@@ -93240,9 +92821,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -93304,10 +92885,10 @@ paths:
type: array
items: *219
examples:
- default: *667
- '301': *468
+ default: *664
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
'422': *15
x-github:
githubCloudOnly: false
@@ -93324,15 +92905,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
responses:
'204':
description: Response
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93351,9 +92932,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: name
in: path
required: true
@@ -93377,9 +92958,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93399,9 +92980,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -93429,7 +93010,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *655
+ '410': *652
'404': *6
'422': *15
x-github:
@@ -93447,9 +93028,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
responses:
'204':
description: Response
@@ -93479,9 +93060,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
responses:
'200':
description: Response
@@ -93489,10 +93070,10 @@ paths:
application/json:
schema: *220
examples:
- default: *663
- '301': *468
+ default: *660
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93509,9 +93090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -93537,13 +93118,13 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93561,9 +93142,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93595,16 +93176,16 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -93626,10 +93207,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *462
- - *463
- - *664
- - *659
+ - *459
+ - *460
+ - *661
+ - *656
responses:
'204':
description: Response
@@ -93658,9 +93239,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93684,7 +93265,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -93717,9 +93298,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -93731,11 +93312,11 @@ paths:
type: array
items: *220
examples:
- default: *666
+ default: *663
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93763,9 +93344,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93794,14 +93375,14 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *655
+ '410': *652
'422': *15
'404': *6
x-github:
@@ -93821,9 +93402,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93856,7 +93437,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
'403': *29
'404': *6
'422': *7
@@ -93878,9 +93459,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -93895,6 +93476,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *665
+ - *666
+ - *667
- *668
- *669
- *670
@@ -93905,9 +93489,6 @@ paths:
- *675
- *676
- *677
- - *678
- - *679
- - *680
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -94216,7 +93797,7 @@ paths:
type: string
comments:
type: array
- items: &702
+ items: &699
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -94425,7 +94006,7 @@ paths:
type: string
comments:
type: array
- items: *576
+ items: *573
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -94714,7 +94295,7 @@ paths:
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94731,8 +94312,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -94742,7 +94323,7 @@ paths:
application/json:
schema:
type: array
- items: &681
+ items: &678
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -94808,8 +94389,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -94845,9 +94426,9 @@ paths:
description: Response
content:
application/json:
- schema: *681
+ schema: *678
examples:
- default: &682
+ default: &679
value:
id: 1
key: ssh-rsa AAA...
@@ -94881,9 +94462,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *462
- - *463
- - &683
+ - *459
+ - *460
+ - &680
name: key_id
description: The unique identifier of the key.
in: path
@@ -94895,9 +94476,9 @@ paths:
description: Response
content:
application/json:
- schema: *681
+ schema: *678
examples:
- default: *682
+ default: *679
'404': *6
x-github:
githubCloudOnly: false
@@ -94915,9 +94496,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *462
- - *463
- - *683
+ - *459
+ - *460
+ - *680
responses:
'204':
description: Response
@@ -94937,8 +94518,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -94950,7 +94531,7 @@ paths:
type: array
items: *219
examples:
- default: *667
+ default: *664
headers:
Link: *47
'404': *6
@@ -94971,8 +94552,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95010,7 +94591,7 @@ paths:
application/json:
schema: *219
examples:
- default: &684
+ default: &681
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -95042,8 +94623,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: name
in: path
required: true
@@ -95056,7 +94637,7 @@ paths:
application/json:
schema: *219
examples:
- default: *684
+ default: *681
'404': *6
x-github:
githubCloudOnly: false
@@ -95073,8 +94654,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: name
in: path
required: true
@@ -95139,8 +94720,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: name
in: path
required: true
@@ -95166,8 +94747,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -95203,8 +94784,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'202': *39
'403':
@@ -95232,8 +94813,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -95259,9 +94840,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *462
- - *463
- - *549
+ - *459
+ - *460
+ - *546
responses:
'200':
description: Response
@@ -95406,8 +94987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95472,8 +95053,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95507,9 +95088,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *685
+ default: *682
'204':
description: Response when already merged
'404':
@@ -95534,8 +95115,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -95576,7 +95157,7 @@ paths:
application/json:
schema:
type: array
- items: &686
+ items: &683
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -95637,8 +95218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95678,9 +95259,9 @@ paths:
description: Response
content:
application/json:
- schema: *686
+ schema: *683
examples:
- default: &687
+ default: &684
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -95739,9 +95320,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone
parameters:
- - *462
- - *463
- - &688
+ - *459
+ - *460
+ - &685
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -95753,9 +95334,9 @@ paths:
description: Response
content:
application/json:
- schema: *686
+ schema: *683
examples:
- default: *687
+ default: *684
'404': *6
x-github:
githubCloudOnly: false
@@ -95772,9 +95353,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone
parameters:
- - *462
- - *463
- - *688
+ - *459
+ - *460
+ - *685
requestBody:
required: false
content:
@@ -95812,9 +95393,9 @@ paths:
description: Response
content:
application/json:
- schema: *686
+ schema: *683
examples:
- default: *687
+ default: *684
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95830,9 +95411,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone
parameters:
- - *462
- - *463
- - *688
+ - *459
+ - *460
+ - *685
responses:
'204':
description: Response
@@ -95853,9 +95434,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *462
- - *463
- - *688
+ - *459
+ - *460
+ - *685
- *17
- *19
responses:
@@ -95867,7 +95448,7 @@ paths:
type: array
items: *219
examples:
- default: *667
+ default: *664
headers:
Link: *47
x-github:
@@ -95886,12 +95467,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *462
- - *463
- - *689
- - *690
+ - *459
+ - *460
+ - *686
+ - *687
- *227
- - *691
+ - *688
- *17
- *19
responses:
@@ -95903,7 +95484,7 @@ paths:
type: array
items: *247
examples:
- default: *692
+ default: *689
headers:
Link: *47
x-github:
@@ -95927,8 +95508,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -95986,14 +95567,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &693
+ schema: &690
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -96118,7 +95699,7 @@ paths:
- custom_404
- public
examples:
- default: &694
+ default: &691
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -96159,8 +95740,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -96214,9 +95795,9 @@ paths:
description: Response
content:
application/json:
- schema: *693
+ schema: *690
examples:
- default: *694
+ default: *691
'422': *15
'409': *118
x-github:
@@ -96239,8 +95820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -96347,8 +95928,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -96374,8 +95955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -96385,7 +95966,7 @@ paths:
application/json:
schema:
type: array
- items: &695
+ items: &692
title: Page Build
description: Page Build
type: object
@@ -96479,8 +96060,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'201':
description: Response
@@ -96525,16 +96106,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *695
+ schema: *692
examples:
- default: &696
+ default: &693
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -96582,8 +96163,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: build_id
in: path
required: true
@@ -96594,9 +96175,9 @@ paths:
description: Response
content:
application/json:
- schema: *695
+ schema: *692
examples:
- default: *696
+ default: *693
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96616,8 +96197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -96722,9 +96303,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *462
- - *463
- - &697
+ - *459
+ - *460
+ - &694
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -96782,9 +96363,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *462
- - *463
- - *697
+ - *459
+ - *460
+ - *694
responses:
'204': *154
'404': *6
@@ -96811,8 +96392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -97070,8 +96651,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Private vulnerability reporting status
@@ -97108,8 +96689,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'422': *14
@@ -97130,8 +96711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'422': *14
@@ -97153,8 +96734,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -97164,7 +96745,7 @@ paths:
type: array
items: *155
examples:
- default: *698
+ default: *695
'403': *29
'404': *6
x-github:
@@ -97186,8 +96767,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -97203,7 +96784,7 @@ paths:
required:
- properties
examples:
- default: *699
+ default: *696
responses:
'204':
description: No Content when custom property values are successfully created
@@ -97241,8 +96822,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -97302,9 +96883,9 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *580
examples:
- default: *700
+ default: *697
headers:
Link: *47
'304': *37
@@ -97336,8 +96917,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -97402,7 +96983,7 @@ paths:
description: Response
content:
application/json:
- schema: &704
+ schema: &701
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -97616,7 +97197,7 @@ paths:
- review_comment
- self
author_association: *221
- auto_merge: *701
+ auto_merge: *698
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -97708,7 +97289,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &705
+ default: &702
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -98235,8 +97816,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sort
in: query
required: false
@@ -98265,9 +97846,9 @@ paths:
application/json:
schema:
type: array
- items: *702
+ items: *699
examples:
- default: &707
+ default: &704
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -98344,17 +97925,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'200':
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
- default: &703
+ default: &700
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -98429,8 +98010,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -98453,9 +98034,9 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
- default: *703
+ default: *700
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98471,8 +98052,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'204':
@@ -98494,8 +98075,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -98522,9 +98103,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
@@ -98545,8 +98126,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -98579,16 +98160,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -98610,10 +98191,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- - *659
+ - *656
responses:
'204':
description: Response
@@ -98656,9 +98237,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request
parameters:
- - *462
- - *463
- - &706
+ - *459
+ - *460
+ - &703
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -98671,9 +98252,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *704
+ schema: *701
examples:
- default: *705
+ default: *702
'304': *37
'404': *6
'406':
@@ -98708,9 +98289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -98752,9 +98333,9 @@ paths:
description: Response
content:
application/json:
- schema: *704
+ schema: *701
examples:
- default: *705
+ default: *702
'422': *15
'403': *29
x-github:
@@ -98776,9 +98357,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: true
content:
@@ -98840,7 +98421,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -98848,7 +98429,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'401': *25
'403': *29
'404': *6
@@ -98878,9 +98459,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *244
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -98901,9 +98482,9 @@ paths:
application/json:
schema:
type: array
- items: *702
+ items: *699
examples:
- default: *707
+ default: *704
headers:
Link: *47
x-github:
@@ -98936,9 +98517,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: true
content:
@@ -99043,7 +98624,7 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
example-for-a-multi-line-comment:
value:
@@ -99131,9 +98712,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *236
requestBody:
required: true
@@ -99156,7 +98737,7 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
default:
value:
@@ -99242,9 +98823,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *17
- *19
responses:
@@ -99254,9 +98835,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *576
examples:
- default: *708
+ default: *705
headers:
Link: *47
x-github:
@@ -99286,9 +98867,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *17
- *19
responses:
@@ -99298,7 +98879,7 @@ paths:
application/json:
schema:
type: array
- items: *592
+ items: *589
examples:
default:
value:
@@ -99336,9 +98917,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
responses:
'204':
description: Response if pull request has been merged
@@ -99361,9 +98942,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -99474,9 +99055,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
responses:
'200':
description: Response
@@ -99551,9 +99132,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -99590,7 +99171,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
default:
value:
@@ -100126,9 +99707,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: true
content:
@@ -100162,7 +99743,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
default:
value:
@@ -100667,9 +100248,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *17
- *19
responses:
@@ -100679,7 +100260,7 @@ paths:
application/json:
schema:
type: array
- items: &709
+ items: &706
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -100830,9 +100411,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -100918,9 +100499,9 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: &711
+ default: &708
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -100983,10 +100564,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - &710
+ - *459
+ - *460
+ - *703
+ - &707
name: review_id
description: The unique identifier of the review.
in: path
@@ -100998,9 +100579,9 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: &712
+ default: &709
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -101059,10 +100640,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
requestBody:
required: true
content:
@@ -101085,7 +100666,7 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
default:
value:
@@ -101147,18 +100728,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
responses:
'200':
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: *711
+ default: *708
'422': *7
'404': *6
x-github:
@@ -101185,10 +100766,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
- *17
- *19
responses:
@@ -101423,10 +101004,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
requestBody:
required: true
content:
@@ -101454,7 +101035,7 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
default:
value:
@@ -101517,10 +101098,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
requestBody:
required: true
content:
@@ -101555,9 +101136,9 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: *712
+ default: *709
'404': *6
'422': *7
'403': *29
@@ -101579,9 +101160,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -101644,8 +101225,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -101658,9 +101239,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: &714
+ default: &711
value:
type: file
encoding: base64
@@ -101702,8 +101283,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: dir
description: The alternate path to look for a README file
in: path
@@ -101723,9 +101304,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: *714
+ default: *711
'404': *6
'422': *15
x-github:
@@ -101747,8 +101328,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -101758,7 +101339,7 @@ paths:
application/json:
schema:
type: array
- items: *715
+ items: *712
examples:
default:
value:
@@ -101852,8 +101433,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -101929,9 +101510,9 @@ paths:
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: &719
+ default: &716
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -102036,9 +101617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset
parameters:
- - *462
- - *463
- - &717
+ - *459
+ - *460
+ - &714
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -102050,9 +101631,9 @@ paths:
description: Response
content:
application/json:
- schema: *716
+ schema: *713
examples:
- default: &718
+ default: &715
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
@@ -102087,7 +101668,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *594
+ '302': *591
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -102103,9 +101684,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset
parameters:
- - *462
- - *463
- - *717
+ - *459
+ - *460
+ - *714
requestBody:
required: false
content:
@@ -102133,9 +101714,9 @@ paths:
description: Response
content:
application/json:
- schema: *716
+ schema: *713
examples:
- default: *718
+ default: *715
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -102151,9 +101732,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset
parameters:
- - *462
- - *463
- - *717
+ - *459
+ - *460
+ - *714
responses:
'204':
description: Response
@@ -102177,8 +101758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -102263,16 +101844,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -102289,8 +101870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tag
description: tag parameter
in: path
@@ -102303,9 +101884,9 @@ paths:
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
'404': *6
x-github:
githubCloudOnly: false
@@ -102327,9 +101908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release
parameters:
- - *462
- - *463
- - &720
+ - *459
+ - *460
+ - &717
name: release_id
description: The unique identifier of the release.
in: path
@@ -102343,9 +101924,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
'401':
description: Unauthorized
x-github:
@@ -102363,9 +101944,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
requestBody:
required: false
content:
@@ -102429,9 +102010,9 @@ paths:
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -102452,9 +102033,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
responses:
'204':
description: Response
@@ -102474,9 +102055,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
- *17
- *19
responses:
@@ -102486,7 +102067,7 @@ paths:
application/json:
schema:
type: array
- items: *716
+ items: *713
examples:
default:
value:
@@ -102568,9 +102149,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:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
- name: name
in: query
required: true
@@ -102596,7 +102177,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *716
+ schema: *713
examples:
response-for-successful-upload:
value:
@@ -102651,9 +102232,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -102677,9 +102258,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
@@ -102700,9 +102281,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
requestBody:
required: true
content:
@@ -102732,16 +102313,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -102763,10 +102344,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *462
- - *463
- - *720
- - *659
+ - *459
+ - *460
+ - *717
+ - *656
responses:
'204':
description: Response
@@ -102790,9 +102371,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
- *17
- *19
responses:
@@ -102809,7 +102390,7 @@ paths:
oneOf:
- allOf:
- *169
- - &721
+ - &718
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -102830,67 +102411,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *170
- - *721
+ - *718
- allOf:
- *171
- - *721
+ - *718
- allOf:
- *172
- - *721
+ - *718
- allOf:
- - *722
- - *721
+ - *719
+ - *718
- allOf:
- *173
- - *721
+ - *718
- allOf:
- *174
- - *721
+ - *718
- allOf:
- *175
- - *721
+ - *718
- allOf:
- *176
- - *721
+ - *718
- allOf:
- *177
- - *721
+ - *718
- allOf:
- *178
- - *721
+ - *718
- allOf:
- *179
- - *721
+ - *718
- allOf:
- *180
- - *721
+ - *718
- allOf:
- *181
- - *721
+ - *718
- allOf:
- *182
- - *721
+ - *718
- allOf:
- *183
- - *721
+ - *718
- allOf:
- *184
- - *721
+ - *718
- allOf:
- *185
- - *721
+ - *718
- allOf:
- *186
- - *721
+ - *718
- allOf:
- *187
- - *721
+ - *718
- allOf:
- *188
- - *721
+ - *718
- allOf:
- *189
- - *721
+ - *718
examples:
default:
value:
@@ -102929,8 +102510,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- name: includes_parents
@@ -102941,7 +102522,7 @@ paths:
schema:
type: boolean
default: true
- - *723
+ - *720
responses:
'200':
description: Response
@@ -102996,8 +102577,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
description: Request body
required: true
@@ -103026,7 +102607,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *724
+ items: *721
required:
- name
- enforcement
@@ -103059,7 +102640,7 @@ paths:
application/json:
schema: *190
examples:
- default: &733
+ default: &730
value:
id: 42
name: super cool ruleset
@@ -103106,12 +102687,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *462
- - *463
- - *725
+ - *459
+ - *460
+ - *722
- *105
- - *726
- - *727
+ - *723
+ - *724
- *17
- *19
responses:
@@ -103119,9 +102700,9 @@ paths:
description: Response
content:
application/json:
- schema: *728
+ schema: *725
examples:
- default: *729
+ default: *726
'404': *6
'500': *40
x-github:
@@ -103142,17 +102723,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *462
- - *463
- - *730
+ - *459
+ - *460
+ - *727
responses:
'200':
description: Response
content:
application/json:
- schema: *731
+ schema: *728
examples:
- default: *732
+ default: *729
'404': *6
'500': *40
x-github:
@@ -103180,8 +102761,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103203,7 +102784,7 @@ paths:
application/json:
schema: *190
examples:
- default: *733
+ default: *730
'404': *6
'500': *40
put:
@@ -103221,8 +102802,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103256,7 +102837,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *724
+ items: *721
examples:
default:
value:
@@ -103286,7 +102867,7 @@ paths:
application/json:
schema: *190
examples:
- default: *733
+ default: *730
'404': *6
'500': *40
delete:
@@ -103304,8 +102885,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103328,8 +102909,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- name: ruleset_id
@@ -103366,8 +102947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103440,8 +103021,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *427
- *428
- *429
@@ -103450,8 +103031,8 @@ paths:
- *110
- *19
- *17
- - *734
- - *735
+ - *731
+ - *732
- *432
- *433
- *434
@@ -103463,7 +103044,7 @@ paths:
application/json:
schema:
type: array
- items: &739
+ items: &736
type: object
properties:
number: *127
@@ -103482,8 +103063,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *736
- resolution: *737
+ state: *733
+ resolution: *734
resolved_at:
type: string
format: date-time
@@ -103579,7 +103160,7 @@ paths:
pull request.
'
- oneOf: *738
+ oneOf: *735
nullable: true
has_more_locations:
type: boolean
@@ -103728,16 +103309,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
- *435
responses:
'200':
description: Response
content:
application/json:
- schema: *739
+ schema: *736
examples:
default:
value:
@@ -103791,9 +103372,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
requestBody:
required: true
content:
@@ -103801,8 +103382,8 @@ paths:
schema:
type: object
properties:
- state: *736
- resolution: *737
+ state: *733
+ resolution: *734
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -103836,7 +103417,7 @@ paths:
description: Response
content:
application/json:
- schema: *739
+ schema: *736
examples:
default:
value:
@@ -103931,9 +103512,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
- *19
- *17
responses:
@@ -103944,7 +103525,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &928
+ items: &923
type: object
properties:
type:
@@ -103970,6 +103551,9 @@ paths:
example: commit
details:
oneOf:
+ - *737
+ - *738
+ - *739
- *740
- *741
- *742
@@ -103980,9 +103564,6 @@ paths:
- *747
- *748
- *749
- - *750
- - *751
- - *752
examples:
default:
value:
@@ -104068,8 +103649,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -104077,14 +103658,14 @@ paths:
schema:
type: object
properties:
- reason: &754
+ reason: &751
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *753
+ placeholder_id: *750
required:
- reason
- placeholder_id
@@ -104101,7 +103682,7 @@ paths:
schema:
type: object
properties:
- reason: *754
+ reason: *751
expire_at:
type: string
format: date-time
@@ -104147,8 +103728,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -104163,7 +103744,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &755
+ items: &752
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -104189,15 +103770,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *755
+ items: *752
backfill_scans:
type: array
- items: *755
+ items: *752
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *755
+ - *752
- type: object
properties:
pattern_name:
@@ -104267,8 +103848,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *110
- name: sort
description: The property to sort the results by.
@@ -104312,9 +103893,9 @@ paths:
application/json:
schema:
type: array
- items: *756
+ items: *753
examples:
- default: *757
+ default: *754
'400': *14
'404': *6
x-github:
@@ -104337,8 +103918,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -104498,9 +104079,9 @@ paths:
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
- default: &759
+ default: &756
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -104733,8 +104314,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -104838,7 +104419,7 @@ paths:
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
default:
value:
@@ -104985,17 +104566,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
responses:
'200':
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
- default: *759
+ default: *756
'403': *29
'404': *6
x-github:
@@ -105019,9 +104600,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
requestBody:
required: true
content:
@@ -105180,10 +104761,10 @@ paths:
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
- default: *759
- add_credit: *759
+ default: *756
+ add_credit: *756
'403': *29
'404': *6
'422':
@@ -105221,9 +104802,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
responses:
'202': *39
'400': *14
@@ -105250,17 +104831,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
responses:
'202':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
'400': *14
'422': *15
'403': *29
@@ -105286,8 +104867,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -105386,8 +104967,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -105396,7 +104977,7 @@ paths:
application/json:
schema:
type: array
- items: &760
+ items: &757
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -105429,8 +105010,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -105506,8 +105087,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -105603,8 +105184,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -105758,8 +105339,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -105769,7 +105350,7 @@ paths:
application/json:
schema:
type: array
- items: *760
+ items: *757
examples:
default:
value:
@@ -105802,8 +105383,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sha
in: path
required: true
@@ -105857,7 +105438,7 @@ paths:
description: Response
content:
application/json:
- schema: *761
+ schema: *758
examples:
default:
value:
@@ -105911,8 +105492,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -105944,14 +105525,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &762
+ schema: &759
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -106019,8 +105600,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -106046,7 +105627,7 @@ paths:
description: Response
content:
application/json:
- schema: *762
+ schema: *759
examples:
default:
value:
@@ -106073,8 +105654,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -106094,8 +105675,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -106174,8 +105755,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -106183,7 +105764,7 @@ paths:
application/json:
schema:
type: array
- items: &763
+ items: &760
title: Tag protection
description: Tag protection
type: object
@@ -106235,8 +105816,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -106259,7 +105840,7 @@ paths:
description: Response
content:
application/json:
- schema: *763
+ schema: *760
examples:
default:
value:
@@ -106290,8 +105871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -106328,8 +105909,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
in: path
required: true
@@ -106365,8 +105946,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -106398,8 +105979,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *19
- *17
responses:
@@ -106407,7 +105988,7 @@ paths:
description: Response
content:
application/json:
- schema: &764
+ schema: &761
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -106419,7 +106000,7 @@ paths:
required:
- names
examples:
- default: &765
+ default: &762
value:
names:
- octocat
@@ -106442,8 +106023,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -106474,9 +106055,9 @@ paths:
description: Response
content:
application/json:
- schema: *764
+ schema: *761
examples:
- default: *765
+ default: *762
'404': *6
'422': *7
x-github:
@@ -106497,9 +106078,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones
parameters:
- - *462
- - *463
- - &766
+ - *459
+ - *460
+ - &763
name: per
description: The time frame to display results for.
in: query
@@ -106528,7 +106109,7 @@ paths:
example: 128
clones:
type: array
- items: &767
+ items: &764
title: Traffic
type: object
properties:
@@ -106616,8 +106197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -106708,8 +106289,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -106770,9 +106351,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views
parameters:
- - *462
- - *463
- - *766
+ - *459
+ - *460
+ - *763
responses:
'200':
description: Response
@@ -106791,7 +106372,7 @@ paths:
example: 3782
views:
type: array
- items: *767
+ items: *764
required:
- uniques
- count
@@ -106869,8 +106450,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -107144,8 +106725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -107168,8 +106749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -107191,8 +106772,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -107218,8 +106799,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
in: path
required: true
@@ -107311,9 +106892,9 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -107464,7 +107045,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &775
+ - &772
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -107473,7 +107054,7 @@ paths:
schema:
type: string
example: members
- - &780
+ - &777
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -107484,7 +107065,7 @@ paths:
default: 1
format: int32
example: 1
- - &781
+ - &778
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -107526,7 +107107,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &770
+ items: &767
allOf:
- type: object
required:
@@ -107601,7 +107182,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &782
+ meta: &779
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -107661,30 +107242,30 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &771
+ '400': &768
description: Bad request
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '401': *769
- '403': &772
+ schema: *765
+ '401': *766
+ '403': &769
description: Permission denied
- '429': &773
+ '429': &770
description: Too many requests
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '500': &774
+ schema: *765
+ '500': &771
description: Internal server error
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
+ schema: *765
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107708,7 +107289,7 @@ paths:
required: true
content:
application/json:
- schema: &778
+ schema: &775
type: object
required:
- schemas
@@ -107768,9 +107349,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- group: &776
+ group: &773
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -107789,13 +107370,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *771
- '401': *769
- '403': *772
- '409': &779
+ '400': *768
+ '401': *766
+ '403': *769
+ '409': &776
description: Duplicate record detected
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107812,7 +107393,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &777
+ - &774
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -107820,22 +107401,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *775
+ - *772
- *41
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- default: *776
- '400': *771
- '401': *769
- '403': *772
+ default: *773
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107854,13 +107435,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *777
+ - *774
- *41
requestBody:
required: true
content:
application/json:
- schema: *778
+ schema: *775
examples:
group:
summary: Group
@@ -107886,17 +107467,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- group: *776
- groupWithMembers: *776
- '400': *771
- '401': *769
- '403': *772
+ group: *773
+ groupWithMembers: *773
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107920,13 +107501,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *777
+ - *774
- *41
requestBody:
required: true
content:
application/json:
- schema: &789
+ schema: &786
type: object
required:
- Operations
@@ -107986,17 +107567,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- updateGroup: *776
- addMembers: *776
- '400': *771
- '401': *769
- '403': *772
+ updateGroup: *773
+ addMembers: *773
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108012,17 +107593,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *777
+ - *774
- *41
responses:
'204':
description: Group was deleted, no content
- '400': *771
- '401': *769
- '403': *772
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108056,8 +107637,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *780
- - *781
+ - *777
+ - *778
- *41
responses:
'200':
@@ -108090,7 +107671,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &784
+ items: &781
allOf:
- type: object
required:
@@ -108169,7 +107750,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &783
+ roles: &780
type: array
description: The roles assigned to the user.
items:
@@ -108225,7 +107806,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *782
+ meta: *779
startIndex:
type: integer
description: A starting index for the returned page
@@ -108262,11 +107843,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *771
- '401': *769
- '403': *772
- '429': *773
- '500': *774
+ '400': *768
+ '401': *766
+ '403': *769
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108290,7 +107871,7 @@ paths:
required: true
content:
application/json:
- schema: &787
+ schema: &784
type: object
required:
- schemas
@@ -108372,9 +107953,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *783
+ roles: *780
examples:
- user: &788
+ user: &785
summary: User
value:
schemas:
@@ -108421,9 +108002,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- user: &785
+ user: &782
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -108449,13 +108030,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *785
- '400': *771
- '401': *769
- '403': *772
- '409': *779
- '429': *773
- '500': *774
+ enterpriseOwner: *782
+ '400': *768
+ '401': *766
+ '403': *769
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108472,7 +108053,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &786
+ - &783
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -108485,15 +108066,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- default: *785
- '400': *771
- '401': *769
- '403': *772
+ default: *782
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108515,30 +108096,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *786
+ - *783
- *41
requestBody:
required: true
content:
application/json:
- schema: *787
+ schema: *784
examples:
- user: *788
+ user: *785
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- user: *785
- '400': *771
- '401': *769
- '403': *772
+ user: *782
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108573,13 +108154,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *786
+ - *783
- *41
requestBody:
required: true
content:
application/json:
- schema: *789
+ schema: *786
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -108619,18 +108200,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- userMultiValuedProperties: *785
- userSingleValuedProperties: *785
- disableUser: *785
- '400': *771
- '401': *769
- '403': *772
+ userMultiValuedProperties: *782
+ userSingleValuedProperties: *782
+ disableUser: *782
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108650,17 +108231,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *786
+ - *783
- *41
responses:
'204':
description: User was deleted, no content
- '400': *771
- '401': *769
- '403': *772
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108747,7 +108328,7 @@ paths:
example: 1
Resources:
type: array
- items: &790
+ items: &787
title: SCIM /Users
description: SCIM /Users provisioning endpoints
type: object
@@ -108978,22 +108559,22 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243
'304': *37
- '404': &791
+ '404': &788
description: Resource not found
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '403': &792
+ schema: *765
+ '403': &789
description: Forbidden
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '400': *771
- '429': *773
+ schema: *765
+ '400': *768
+ '429': *770
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -109019,9 +108600,9 @@ paths:
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: &793
+ default: &790
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -109044,17 +108625,17 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32
'304': *37
- '404': *791
- '403': *792
- '500': *774
+ '404': *788
+ '403': *789
+ '500': *771
'409':
description: Conflict
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '400': *771
+ schema: *765
+ '400': *768
requestBody:
required: true
content:
@@ -109152,17 +108733,17 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user
parameters:
- *87
- - *786
+ - *783
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: *793
- '404': *791
- '403': *792
+ default: *790
+ '404': *788
+ '403': *789
'304': *37
x-github:
githubCloudOnly: true
@@ -109186,18 +108767,18 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership
parameters:
- *87
- - *786
+ - *783
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: *793
+ default: *790
'304': *37
- '404': *791
- '403': *792
+ '404': *788
+ '403': *789
requestBody:
required: true
content:
@@ -109310,19 +108891,19 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user
parameters:
- *87
- - *786
+ - *783
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: *793
+ default: *790
'304': *37
- '404': *791
- '403': *792
- '400': *771
+ '404': *788
+ '403': *789
+ '400': *768
'429':
description: Response
content:
@@ -109413,12 +108994,12 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization
parameters:
- *87
- - *786
+ - *783
responses:
'204':
description: Response
- '404': *791
- '403': *792
+ '404': *788
+ '403': *789
'304': *37
x-github:
githubCloudOnly: true
@@ -109551,7 +109132,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &794
+ text_matches: &791
title: Search Result Text Matches
type: array
items:
@@ -109714,7 +109295,7 @@ paths:
enum:
- author-date
- committer-date
- - &795
+ - &792
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
@@ -109785,7 +109366,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *513
+ properties: *510
nullable: true
comment_count:
type: integer
@@ -109805,7 +109386,7 @@ paths:
url:
type: string
format: uri
- verification: *641
+ verification: *638
required:
- author
- committer
@@ -109824,7 +109405,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *513
+ properties: *510
nullable: true
parents:
type: array
@@ -109842,7 +109423,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *794
+ text_matches: *791
required:
- sha
- node_id
@@ -110035,7 +109616,7 @@ paths:
- interactions
- created
- updated
- - *795
+ - *792
- *17
- *19
- name: advanced_search
@@ -110132,11 +109713,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
type: string
state_reason:
@@ -110168,7 +109749,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *794
+ text_matches: *791
pull_request:
type: object
properties:
@@ -110393,7 +109974,7 @@ paths:
enum:
- created
- updated
- - *795
+ - *792
- *17
- *19
responses:
@@ -110437,7 +110018,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *794
+ text_matches: *791
required:
- id
- node_id
@@ -110523,7 +110104,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *795
+ - *792
- *17
- *19
responses:
@@ -110762,7 +110343,7 @@ paths:
- admin
- pull
- push
- text_matches: *794
+ text_matches: *791
temp_clone_token:
type: string
allow_merge_commit:
@@ -111063,7 +110644,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *794
+ text_matches: *791
related:
type: array
nullable: true
@@ -111256,7 +110837,7 @@ paths:
- followers
- repositories
- joined
- - *795
+ - *792
- *17
- *19
responses:
@@ -111360,7 +110941,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *794
+ text_matches: *791
blog:
type: string
nullable: true
@@ -111439,7 +111020,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy
parameters:
- - &799
+ - &796
name: team_id
description: The unique identifier of the team.
in: path
@@ -111480,7 +111061,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy
parameters:
- - *799
+ - *796
requestBody:
required: true
content:
@@ -111580,7 +111161,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy
parameters:
- - *799
+ - *796
responses:
'204':
description: Response
@@ -111611,7 +111192,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
parameters:
- - *799
+ - *796
- *110
- *17
- *19
@@ -111624,7 +111205,7 @@ paths:
type: array
items: *451
examples:
- default: *800
+ default: *797
headers:
Link: *47
x-github:
@@ -111653,7 +111234,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *799
+ - *796
requestBody:
required: true
content:
@@ -111716,7 +111297,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *799
+ - *796
- *453
responses:
'200':
@@ -111750,7 +111331,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *799
+ - *796
- *453
requestBody:
required: false
@@ -111776,7 +111357,7 @@ paths:
application/json:
schema: *451
examples:
- default: *801
+ default: *798
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -111801,7 +111382,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *799
+ - *796
- *453
responses:
'204':
@@ -111814,218 +111395,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - *799
- - *453
- - *110
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *454
- examples:
- default: *802
- headers:
- Link: *47
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *455
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- - *456
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *455
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- - *456
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *803
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- - *456
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -112041,7 +111410,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *799
+ - *796
- *17
- *19
responses:
@@ -112079,7 +111448,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy
parameters:
- - *799
+ - *796
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -112130,7 +111499,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112167,7 +111536,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112207,7 +111576,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112244,16 +111613,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'200':
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- response-if-user-is-a-team-maintainer: *804
+ response-if-user-is-a-team-maintainer: *799
'404': *6
x-github:
githubCloudOnly: false
@@ -112286,7 +111655,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *799
+ - *796
- *142
requestBody:
required: false
@@ -112312,9 +111681,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- response-if-users-membership-with-team-is-now-pending: *805
+ response-if-users-membership-with-team-is-now-pending: *800
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -112348,7 +111717,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112376,7 +111745,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy
parameters:
- - *799
+ - *796
- *17
- *19
responses:
@@ -112418,15 +111787,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *799
- - *462
- - *463
+ - *796
+ - *459
+ - *460
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *806
+ schema: *801
examples:
alternative-response-with-extra-repository-information:
value:
@@ -112577,9 +111946,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *799
- - *462
- - *463
+ - *796
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -112629,9 +111998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *799
- - *462
- - *463
+ - *796
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -112660,15 +112029,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy
parameters:
- - *799
+ - *796
responses:
'200':
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *465
+ default: *462
'403': *29
'404': *6
x-github:
@@ -112695,7 +112064,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy
parameters:
- - *799
+ - *796
requestBody:
required: true
content:
@@ -112752,7 +112121,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -112783,7 +112152,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy
parameters:
- - *799
+ - *796
- *17
- *19
responses:
@@ -112795,7 +112164,7 @@ paths:
type: array
items: *312
examples:
- response-if-child-teams-exist: *807
+ response-if-child-teams-exist: *802
headers:
Link: *47
'404': *6
@@ -112828,7 +112197,7 @@ paths:
application/json:
schema:
oneOf:
- - &809
+ - &804
title: Private User
description: Private User
type: object
@@ -113031,7 +112400,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *808
+ - *803
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -113184,7 +112553,7 @@ paths:
description: Response
content:
application/json:
- schema: *809
+ schema: *804
examples:
default:
value:
@@ -113530,7 +112899,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -113538,7 +112907,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'401': *25
'403': *29
'404': *6
@@ -113582,7 +112951,7 @@ paths:
type: integer
secrets:
type: array
- items: &810
+ items: &805
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -113622,7 +112991,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *569
+ default: *566
headers:
Link: *47
x-github:
@@ -113698,7 +113067,7 @@ paths:
description: Response
content:
application/json:
- schema: *810
+ schema: *805
examples:
default:
value:
@@ -113844,7 +113213,7 @@ paths:
type: array
items: *283
examples:
- default: *811
+ default: *806
'401': *25
'403': *29
'404': *6
@@ -113996,7 +113365,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'304': *37
'500': *40
'401': *25
@@ -114054,7 +113423,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'401': *25
'403': *29
'404': *6
@@ -114111,7 +113480,7 @@ paths:
description: Response
content:
application/json:
- schema: &812
+ schema: &807
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -114152,7 +113521,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &813
+ default: &808
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -114197,9 +113566,9 @@ paths:
description: Response
content:
application/json:
- schema: *812
+ schema: *807
examples:
- default: *813
+ default: *808
'404': *6
x-github:
githubCloudOnly: false
@@ -114236,9 +113605,9 @@ paths:
type: integer
machines:
type: array
- items: *814
+ items: *809
examples:
- default: *815
+ default: *810
'304': *37
'500': *40
'401': *25
@@ -114317,13 +113686,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *467
+ repository: *464
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *567
- required: *568
+ properties: *564
+ required: *565
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -115105,7 +114474,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'304': *37
'500': *40
'400': *14
@@ -115145,7 +114514,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'500': *40
'401': *25
'403': *29
@@ -115177,7 +114546,7 @@ paths:
type: array
items: *387
examples:
- default: &826
+ default: &821
value:
- id: 197
name: hello_docker
@@ -115278,7 +114647,7 @@ paths:
application/json:
schema:
type: array
- items: &816
+ items: &811
title: Email
description: Email
type: object
@@ -115343,9 +114712,9 @@ paths:
application/json:
schema:
type: array
- items: *816
+ items: *811
examples:
- default: &828
+ default: &823
value:
- email: octocat@github.com
verified: true
@@ -115420,7 +114789,7 @@ paths:
application/json:
schema:
type: array
- items: *816
+ items: *811
examples:
default:
value:
@@ -115676,7 +115045,7 @@ paths:
application/json:
schema:
type: array
- items: &817
+ items: &812
title: GPG Key
description: A unique encryption key
type: object
@@ -115807,7 +115176,7 @@ paths:
- subkeys
- revoked
examples:
- default: &842
+ default: &837
value:
- id: 3
name: Octocat's GPG Key
@@ -115892,9 +115261,9 @@ paths:
description: Response
content:
application/json:
- schema: *817
+ schema: *812
examples:
- default: &818
+ default: &813
value:
id: 3
name: Octocat's GPG Key
@@ -115951,7 +115320,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &819
+ - &814
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -115963,9 +115332,9 @@ paths:
description: Response
content:
application/json:
- schema: *817
+ schema: *812
examples:
- default: *818
+ default: *813
'404': *6
'304': *37
'403': *29
@@ -115988,7 +115357,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *819
+ - *814
responses:
'204':
description: Response
@@ -116293,7 +115662,7 @@ paths:
required: true
content:
application/json:
- schema: *652
+ schema: *649
examples:
default:
value:
@@ -116443,7 +115812,7 @@ paths:
application/json:
schema:
type: array
- items: &820
+ items: &815
title: Key
description: Key
type: object
@@ -116544,9 +115913,9 @@ paths:
description: Response
content:
application/json:
- schema: *820
+ schema: *815
examples:
- default: &821
+ default: &816
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -116579,15 +115948,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *683
+ - *680
responses:
'200':
description: Response
content:
application/json:
- schema: *820
+ schema: *815
examples:
- default: *821
+ default: *816
'404': *6
'304': *37
'403': *29
@@ -116610,7 +115979,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *683
+ - *680
responses:
'204':
description: Response
@@ -116643,7 +116012,7 @@ paths:
application/json:
schema:
type: array
- items: &822
+ items: &817
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -116711,7 +116080,7 @@ paths:
- account
- plan
examples:
- default: &823
+ default: &818
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -116773,9 +116142,9 @@ paths:
application/json:
schema:
type: array
- items: *822
+ items: *817
examples:
- default: *823
+ default: *818
headers:
Link: *47
'304': *37
@@ -117784,7 +117153,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository
parameters:
- *382
- - *824
+ - *819
responses:
'204':
description: Response
@@ -117899,7 +117268,7 @@ paths:
- docker
- nuget
- container
- - *825
+ - *820
- *19
- *17
responses:
@@ -117911,8 +117280,8 @@ paths:
type: array
items: *387
examples:
- default: *826
- '400': *827
+ default: *821
+ '400': *822
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -117941,7 +117310,7 @@ paths:
application/json:
schema: *387
examples:
- default: &843
+ default: &838
value:
id: 40201
name: octo-name
@@ -118303,9 +117672,9 @@ paths:
application/json:
schema:
type: array
- items: *816
+ items: *811
examples:
- default: *828
+ default: *823
headers:
Link: *47
'304': *37
@@ -118418,7 +117787,7 @@ paths:
type: array
items: *78
examples:
- default: &835
+ default: &830
summary: Default response
value:
- id: 1296269
@@ -118722,9 +118091,9 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -118762,9 +118131,9 @@ paths:
application/json:
schema:
type: array
- items: *654
+ items: *651
examples:
- default: *829
+ default: *824
headers:
Link: *47
'304': *37
@@ -118843,7 +118212,7 @@ paths:
application/json:
schema:
type: array
- items: &830
+ items: &825
title: Social account
description: Social media account
type: object
@@ -118858,7 +118227,7 @@ paths:
- provider
- url
examples:
- default: &831
+ default: &826
value:
- provider: twitter
url: https://twitter.com/github
@@ -118920,9 +118289,9 @@ paths:
application/json:
schema:
type: array
- items: *830
+ items: *825
examples:
- default: *831
+ default: *826
'422': *15
'304': *37
'404': *6
@@ -119009,7 +118378,7 @@ paths:
application/json:
schema:
type: array
- items: &832
+ items: &827
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -119029,7 +118398,7 @@ paths:
- title
- created_at
examples:
- default: &857
+ default: &852
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -119093,9 +118462,9 @@ paths:
description: Response
content:
application/json:
- schema: *832
+ schema: *827
examples:
- default: &833
+ default: &828
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -119125,7 +118494,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &834
+ - &829
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -119137,9 +118506,9 @@ paths:
description: Response
content:
application/json:
- schema: *832
+ schema: *827
examples:
- default: *833
+ default: *828
'404': *6
'304': *37
'403': *29
@@ -119162,7 +118531,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *834
+ - *829
responses:
'204':
description: Response
@@ -119191,7 +118560,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &858
+ - &853
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
@@ -119216,11 +118585,11 @@ paths:
type: array
items: *78
examples:
- default-response: *835
+ default-response: *830
application/vnd.github.v3.star+json:
schema:
type: array
- items: &859
+ items: &854
title: Starred Repository
description: Starred Repository
type: object
@@ -119376,8 +118745,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response if this repository is starred by you
@@ -119405,8 +118774,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -119430,8 +118799,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -119589,10 +118958,10 @@ paths:
application/json:
schema:
oneOf:
- - *809
- - *808
+ - *804
+ - *803
examples:
- default-response: &837
+ default-response: &832
summary: Default response
value:
login: octocat
@@ -119627,7 +118996,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &838
+ response-with-git-hub-plan-information: &833
summary: Response with GitHub plan information
value:
login: octocat
@@ -119749,7 +119118,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users
parameters:
- - *836
+ - *831
- *17
responses:
'200':
@@ -119798,11 +119167,11 @@ paths:
application/json:
schema:
oneOf:
- - *809
- - *808
+ - *804
+ - *803
examples:
- default-response: *837
- response-with-git-hub-plan-information: *838
+ default-response: *832
+ response-with-git-hub-plan-information: *833
'404': *6
x-github:
githubCloudOnly: false
@@ -119852,8 +119221,8 @@ paths:
required:
- subject_digests
examples:
- default: *839
- withPredicateType: *840
+ default: *834
+ withPredicateType: *835
responses:
'200':
description: Response
@@ -119906,7 +119275,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *841
+ default: *836
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -120111,7 +119480,7 @@ paths:
initiator:
type: string
examples:
- default: *509
+ default: *506
'201':
description: Response
content:
@@ -120152,7 +119521,7 @@ paths:
type: array
items: *387
examples:
- default: *826
+ default: *821
'403': *29
'401': *25
x-github:
@@ -120536,9 +119905,9 @@ paths:
application/json:
schema:
type: array
- items: *817
+ items: *812
examples:
- default: *842
+ default: *837
headers:
Link: *47
x-github:
@@ -120642,7 +120011,7 @@ paths:
application/json:
schema: *22
examples:
- default: *651
+ default: *648
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120766,7 +120135,7 @@ paths:
- docker
- nuget
- container
- - *825
+ - *820
- *142
- *19
- *17
@@ -120779,10 +120148,10 @@ paths:
type: array
items: *387
examples:
- default: *826
+ default: *821
'403': *29
'401': *25
- '400': *827
+ '400': *822
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120812,7 +120181,7 @@ paths:
application/json:
schema: *387
examples:
- default: *843
+ default: *838
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -121161,7 +120530,7 @@ paths:
type: array
items: *409
examples:
- default: *844
+ default: *839
headers:
Link: *47
'304': *37
@@ -121221,7 +120590,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *845
+ items: *840
required:
- name
- data_type
@@ -121237,7 +120606,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *846
+ iteration_configuration: *841
required:
- name
- data_type
@@ -121259,8 +120628,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *847
- iteration_field: *848
+ single_select_field: *842
+ iteration_field: *843
responses:
'201':
description: Response
@@ -121268,11 +120637,11 @@ paths:
application/json:
schema: *409
examples:
- text_field: *849
- number_field: *850
- date_field: *851
- single_select_field: *852
- iteration_field: *853
+ text_field: *844
+ number_field: *845
+ date_field: *846
+ single_select_field: *847
+ iteration_field: *848
'304': *37
'403': *29
'401': *25
@@ -121294,7 +120663,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user
parameters:
- *405
- - *854
+ - *849
- *142
responses:
'200':
@@ -121303,7 +120672,7 @@ paths:
application/json:
schema: *409
examples:
- default: *855
+ default: *850
headers:
Link: *47
'304': *37
@@ -121653,7 +121022,7 @@ paths:
parameters:
- *405
- *142
- - *856
+ - *851
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -121932,9 +121301,9 @@ paths:
application/json:
schema:
type: array
- items: *830
+ items: *825
examples:
- default: *831
+ default: *826
headers:
Link: *47
x-github:
@@ -121964,9 +121333,9 @@ paths:
application/json:
schema:
type: array
- items: *832
+ items: *827
examples:
- default: *857
+ default: *852
headers:
Link: *47
x-github:
@@ -121991,7 +121360,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *142
- - *858
+ - *853
- *110
- *17
- *19
@@ -122003,11 +121372,11 @@ paths:
schema:
anyOf:
- type: array
- items: *859
+ items: *854
- type: array
items: *78
examples:
- default-response: *835
+ default-response: *830
headers:
Link: *47
x-github:
@@ -122166,7 +121535,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &860
+ enterprise: &855
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -122224,7 +121593,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &861
+ installation: &856
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -122243,7 +121612,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &862
+ organization: &857
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -122303,13 +121672,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &863
+ repository: &858
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: &900
+ properties: &895
id:
description: Unique identifier of the repository
example: 42
@@ -122992,7 +122361,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &901
+ required: &896
- archive_url
- assignees_url
- blobs_url
@@ -123143,10 +122512,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -123222,11 +122591,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- rule: &864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ rule: &859
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -123449,11 +122818,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- rule: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ rule: *859
sender: *4
required:
- action
@@ -123636,11 +123005,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- rule: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ rule: *859
sender: *4
required:
- action
@@ -123713,7 +123082,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &884
+ schema: &879
title: Exemption request cancellation event
type: object
properties:
@@ -123721,11 +123090,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: &865
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: &860
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -123994,7 +123363,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &866
+ items: &861
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -124104,7 +123473,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &885
+ schema: &880
title: Exemption request completed event
type: object
properties:
@@ -124112,11 +123481,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
sender: *4
required:
- action
@@ -124188,7 +123557,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &882
+ schema: &877
title: Exemption request created event
type: object
properties:
@@ -124196,11 +123565,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
sender: *4
required:
- action
@@ -124272,7 +123641,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &886
+ schema: &881
title: Exemption response dismissed event
type: object
properties:
@@ -124280,12 +123649,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
- exemption_response: *866
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
+ exemption_response: *861
sender: *4
required:
- action
@@ -124359,7 +123728,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &883
+ schema: &878
title: Exemption response submitted event
type: object
properties:
@@ -124367,12 +123736,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
- exemption_response: *866
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
+ exemption_response: *861
sender: *4
required:
- action
@@ -124456,7 +123825,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &868
+ check_run: &863
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -124547,7 +123916,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *867
+ deployment: *862
details_url:
example: https://example.com
type: string
@@ -124632,10 +124001,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
sender: *4
required:
- check_run
@@ -125028,11 +124397,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *868
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ check_run: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
sender: *4
required:
- check_run
@@ -125428,11 +124797,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *868
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ check_run: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
requested_action:
description: The action requested by the user.
type: object
@@ -125837,11 +125206,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *868
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ check_run: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
sender: *4
required:
- check_run
@@ -126818,10 +126187,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -127515,10 +126884,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -128206,10 +127575,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -128375,7 +127744,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128520,20 +127889,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &869
+ commit_oid: &864
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: *860
- installation: *861
- organization: *862
- ref: &870
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: &865
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: *863
+ repository: *858
sender: *4
required:
- action
@@ -128698,7 +128067,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128928,12 +128297,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -129028,7 +128397,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129199,12 +128568,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -129370,7 +128739,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -129536,12 +128905,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -129640,7 +129009,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129815,16 +129184,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
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: *863
+ repository: *858
sender: *4
required:
- action
@@ -129921,7 +129290,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -130061,12 +129430,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -130232,7 +129601,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -130377,10 +129746,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -130635,10 +130004,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -130718,18 +130087,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *862
- pusher_type: &871
+ organization: *857
+ pusher_type: &866
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &872
+ ref: &867
description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference)
resource.
type: string
@@ -130739,7 +130108,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *863
+ repository: *858
sender: *4
required:
- ref
@@ -130822,9 +130191,9 @@ x-webhooks:
enum:
- created
definition: *156
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -130909,9 +130278,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -130989,9 +130358,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *156
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -131069,9 +130438,9 @@ x-webhooks:
enum:
- updated
definition: *156
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -131148,10 +130517,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- repository: *863
- organization: *862
+ enterprise: *855
+ installation: *856
+ repository: *858
+ organization: *857
sender: *4
new_property_values:
type: array
@@ -131236,18 +130605,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- pusher_type: *871
- ref: *872
+ enterprise: *855
+ installation: *856
+ organization: *857
+ pusher_type: *866
+ ref: *867
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *863
+ repository: *858
sender: *4
required:
- ref
@@ -131331,11 +130700,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131419,11 +130788,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131507,11 +130876,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131593,11 +130962,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131679,11 +131048,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131766,11 +131135,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131852,11 +131221,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131933,9 +131302,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- key: &873
+ enterprise: *855
+ installation: *856
+ key: &868
description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -131971,8 +131340,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -132049,11 +131418,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- key: *873
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ key: *868
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -132614,12 +131983,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: &877
+ workflow: &872
title: Workflow
type: object
nullable: true
@@ -133345,13 +132714,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *606
+ deployment: *603
pull_requests:
type: array
- items: *704
- repository: *863
- organization: *862
- installation: *861
+ items: *701
+ repository: *858
+ organization: *857
+ installation: *856
sender: *4
responses:
'200':
@@ -133422,7 +132791,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &874
+ approver: &869
type: object
properties:
avatar_url:
@@ -133465,11 +132834,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- reviewers: &875
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ reviewers: &870
type: array
items:
type: object
@@ -133548,7 +132917,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &876
+ workflow_job_run: &871
type: object
properties:
conclusion:
@@ -134279,18 +133648,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *874
+ approver: *869
comment:
type: string
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- reviewers: *875
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ reviewers: *870
sender: *4
since:
type: string
- workflow_job_run: *876
+ workflow_job_run: *871
workflow_job_runs:
type: array
items:
@@ -134994,13 +134363,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *860
+ enterprise: *855
environment:
type: string
- installation: *861
- organization: *862
- repository: *863
- requestor: &887
+ installation: *856
+ organization: *857
+ repository: *858
+ requestor: &882
title: User
type: object
nullable: true
@@ -136899,12 +136268,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Deployment Workflow Run
type: object
@@ -137584,7 +136953,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &880
+ answer: &875
type: object
properties:
author_association:
@@ -137741,11 +137110,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -137872,11 +137241,11 @@ x-webhooks:
- from
required:
- category
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -137959,11 +137328,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138045,7 +137414,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &879
+ comment: &874
type: object
properties:
author_association:
@@ -138202,11 +137571,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138289,12 +137658,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *879
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ comment: *874
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138389,12 +137758,12 @@ x-webhooks:
- from
required:
- body
- comment: *879
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ comment: *874
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138478,11 +137847,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138564,11 +137933,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138668,11 +138037,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138754,10 +138123,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *878
- enterprise: *860
- installation: *861
- label: &881
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ label: &876
title: Label
type: object
properties:
@@ -138789,8 +138158,8 @@ x-webhooks:
- color
- default
- description
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138873,11 +138242,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138959,11 +138328,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139045,11 +138414,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139134,16 +138503,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *878
- new_repository: *863
+ new_discussion: *873
+ new_repository: *858
required:
- new_discussion
- new_repository
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139226,10 +138595,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *878
- old_answer: *880
- organization: *862
- repository: *863
+ discussion: *873
+ old_answer: *875
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139311,12 +138680,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *878
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139399,11 +138768,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139485,11 +138854,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139558,7 +138927,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139621,7 +138990,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139684,7 +139053,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *884
+ schema: *879
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139747,7 +139116,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139810,7 +139179,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139876,7 +139245,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *884
+ schema: *879
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139942,7 +139311,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *885
+ schema: *880
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140008,7 +139377,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140074,7 +139443,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *886
+ schema: *881
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140140,7 +139509,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140205,7 +139574,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *884
+ schema: *879
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140270,7 +139639,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *885
+ schema: *880
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140335,7 +139704,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140400,7 +139769,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *886
+ schema: *881
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140466,7 +139835,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140533,7 +139902,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *860
+ enterprise: *855
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository)
resource.
@@ -141193,9 +140562,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- forkee
@@ -141341,9 +140710,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pages:
description: The pages that were updated.
type: array
@@ -141380,7 +140749,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *863
+ repository: *858
sender: *4
required:
- pages
@@ -141456,10 +140825,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: &888
+ organization: *857
+ repositories: &883
description: An array of repository objects that the installation
can access.
type: array
@@ -141485,8 +140854,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *863
- requester: *887
+ repository: *858
+ requester: *882
sender: *4
required:
- action
@@ -141561,11 +140930,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -141641,11 +141010,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -141721,10 +141090,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories_added: &889
+ organization: *857
+ repositories_added: &884
description: An array of repository objects, which were added to
the installation.
type: array
@@ -141770,15 +141139,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *863
- repository_selection: &890
+ repository: *858
+ repository_selection: &885
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *887
+ requester: *882
sender: *4
required:
- action
@@ -141857,10 +141226,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories_added: *889
+ organization: *857
+ repositories_added: *884
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -141887,9 +141256,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *863
- repository_selection: *890
- requester: *887
+ repository: *858
+ repository_selection: *885
+ requester: *882
sender: *4
required:
- action
@@ -141968,11 +141337,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -142151,10 +141520,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
target_type:
type: string
@@ -142233,11 +141602,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -142489,8 +141858,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -143284,8 +142653,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143634,8 +143003,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -143715,7 +143084,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &891
+ comment: &886
title: issue comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment)
itself.
@@ -143880,8 +143249,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -144671,8 +144040,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145023,8 +144392,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -145104,7 +144473,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &920
+ changes: &915
description: The changes to the comment.
type: object
properties:
@@ -145116,9 +144485,9 @@ x-webhooks:
type: string
required:
- from
- comment: *891
- enterprise: *860
- installation: *861
+ comment: *886
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -145911,8 +145280,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -146261,8 +145630,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146352,9 +145721,9 @@ x-webhooks:
type: number
blocking_issue: *220
blocking_issue_repo: *78
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146443,9 +145812,9 @@ x-webhooks:
type: number
blocking_issue: *220
blocking_issue_repo: *78
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146533,9 +145902,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146624,9 +145993,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146706,10 +146075,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *887
- enterprise: *860
- installation: *861
- issue: &894
+ assignee: *882
+ enterprise: *855
+ installation: *856
+ issue: &889
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -147498,11 +146867,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -147619,8 +146988,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -147700,8 +147069,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -148495,11 +147864,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148751,8 +148120,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -148831,8 +148200,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -149617,11 +148986,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -149737,8 +149106,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -149817,8 +149186,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -150625,11 +149994,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -150724,7 +150093,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &892
+ milestone: &887
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -150862,8 +150231,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -150962,8 +150331,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -151752,11 +151121,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -151873,9 +151242,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *881
- organization: *862
- repository: *863
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -151955,8 +151324,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -152744,11 +152113,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -152865,9 +152234,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *881
- organization: *862
- repository: *863
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -152947,8 +152316,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -153760,11 +153129,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -153858,8 +153227,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -153938,8 +153307,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -154745,11 +154114,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -154843,9 +154212,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *892
- organization: *862
- repository: *863
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -155713,11 +155082,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -156279,8 +155648,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -157069,11 +156438,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -157189,8 +156558,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -157270,9 +156639,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *860
- installation: *861
- issue: &893
+ enterprise: *855
+ installation: *856
+ issue: &888
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -158055,11 +157424,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -158175,8 +157544,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -158255,8 +157624,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -159066,11 +158435,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -159165,8 +158534,8 @@ x-webhooks:
user_view_type:
type: string
type: *371
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160032,11 +159401,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -160620,11 +159989,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *860
- installation: *861
- issue: *893
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *888
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160704,12 +160073,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *860
- installation: *861
- issue: *894
+ enterprise: *855
+ installation: *856
+ issue: *889
type: *371
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160790,7 +160159,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &923
+ assignee: &918
title: User
type: object
nullable: true
@@ -160860,11 +160229,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *860
- installation: *861
- issue: *894
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *889
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160943,12 +160312,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *860
- installation: *861
- issue: *894
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *889
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -161028,8 +160397,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -161839,11 +161208,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -161937,8 +161306,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162018,11 +161387,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *860
- installation: *861
- issue: *893
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *888
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162101,12 +161470,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *860
- installation: *861
- issue: *894
+ enterprise: *855
+ installation: *856
+ issue: *889
type: *371
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162186,11 +161555,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162268,11 +161637,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162382,11 +161751,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162468,9 +161837,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: &895
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: &890
title: Marketplace Purchase
type: object
required:
@@ -162553,8 +161922,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *862
- previous_marketplace_purchase: &896
+ organization: *857
+ previous_marketplace_purchase: &891
title: Marketplace Purchase
type: object
properties:
@@ -162634,7 +162003,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -162714,10 +162083,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: *895
- organization: *862
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: *890
+ organization: *857
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162800,7 +162169,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -162882,10 +162251,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: *895
- organization: *862
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: *890
+ organization: *857
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162967,7 +162336,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -163048,8 +162417,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -163131,9 +162500,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *862
- previous_marketplace_purchase: *896
- repository: *863
+ organization: *857
+ previous_marketplace_purchase: *891
+ repository: *858
sender: *4
required:
- action
@@ -163213,12 +162582,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: *895
- organization: *862
- previous_marketplace_purchase: *896
- repository: *863
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: *890
+ organization: *857
+ previous_marketplace_purchase: *891
+ repository: *858
sender: *4
required:
- action
@@ -163320,11 +162689,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -163424,11 +162793,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -163507,11 +162876,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -163589,11 +162958,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163669,7 +163038,7 @@ x-webhooks:
required:
- login
- id
- team: &897
+ team: &892
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -163892,11 +163261,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163973,7 +163342,7 @@ x-webhooks:
required:
- login
- id
- team: *897
+ team: *892
required:
- action
- scope
@@ -164055,8 +163424,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *861
- merge_group: &899
+ installation: *856
+ merge_group: &894
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -164075,15 +163444,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *898
+ head_commit: *893
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164169,10 +163538,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *861
- merge_group: *899
- organization: *862
- repository: *863
+ installation: *856
+ merge_group: *894
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164245,7 +163614,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
+ enterprise: *855
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -164354,16 +163723,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -164444,11 +163813,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
- milestone: *892
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164527,9 +163896,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- milestone: &902
+ enterprise: *855
+ installation: *856
+ milestone: &897
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -164666,8 +164035,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164746,11 +164115,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- milestone: *892
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164860,11 +164229,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- milestone: *892
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164944,11 +164313,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *860
- installation: *861
- milestone: *902
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *897
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165027,11 +164396,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *887
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ blocked_user: *882
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165110,11 +164479,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *887
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ blocked_user: *882
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165190,7 +164559,7 @@ x-webhooks:
enum:
- created
definition: *150
- enterprise: *860
+ enterprise: *855
sender: *4
required:
- action
@@ -165270,8 +164639,8 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
sender: *4
required:
- action
@@ -165344,8 +164713,8 @@ x-webhooks:
enum:
- updated
definition: *150
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
sender: *4
required:
- action
@@ -165417,9 +164786,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
new_property_values:
type: array
@@ -165507,9 +164876,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- membership: &903
+ enterprise: *855
+ installation: *856
+ membership: &898
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -165616,8 +164985,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165695,11 +165064,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *860
- installation: *861
- membership: *903
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ membership: *898
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165778,8 +165147,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -165895,10 +165264,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
- user: *887
+ user: *882
required:
- action
- invitation
@@ -165976,11 +165345,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *860
- installation: *861
- membership: *903
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ membership: *898
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -166067,11 +165436,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *860
- installation: *861
- membership: *903
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ membership: *898
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -166147,9 +165516,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
package:
description: Information about the package.
type: object
@@ -166648,7 +166017,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &904
+ items: &899
title: Ruby Gems metadata
type: object
properties:
@@ -166743,7 +166112,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -166819,9 +166188,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
package:
description: Information about the package.
type: object
@@ -167174,7 +166543,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *904
+ items: *899
source_url:
type: string
format: uri
@@ -167244,7 +166613,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -167421,12 +166790,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *860
+ enterprise: *855
id:
type: integer
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- id
@@ -167503,7 +166872,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &905
+ personal_access_token_request: &900
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -167649,10 +167018,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *860
- organization: *862
+ enterprise: *855
+ organization: *857
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167729,11 +167098,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *905
- enterprise: *860
- organization: *862
+ personal_access_token_request: *900
+ enterprise: *855
+ organization: *857
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167809,11 +167178,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *905
- enterprise: *860
- organization: *862
+ personal_access_token_request: *900
+ enterprise: *855
+ organization: *857
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167888,11 +167257,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *905
- organization: *862
- enterprise: *860
+ personal_access_token_request: *900
+ organization: *857
+ enterprise: *855
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167997,7 +167366,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *906
+ last_response: *901
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -168029,8 +167398,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
zen:
description: Random string of GitHub zen.
@@ -168275,10 +167644,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *860
- installation: *861
- organization: *862
- project_card: &907
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_card: &902
title: Project Card
type: object
properties:
@@ -168397,7 +167766,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -168478,11 +167847,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- project_card: *907
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_card: *902
+ repository: *858
sender: *4
required:
- action
@@ -168562,9 +167931,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
project_card:
title: Project Card
type: object
@@ -168692,8 +168061,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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -168787,11 +168156,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *860
- installation: *861
- organization: *862
- project_card: *907
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_card: *902
+ repository: *858
sender: *4
required:
- action
@@ -168885,9 +168254,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
project_card:
allOf:
- title: Project Card
@@ -169077,7 +168446,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -169157,10 +168526,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
- organization: *862
- project: &909
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: &904
title: Project
type: object
properties:
@@ -169284,7 +168653,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -169364,10 +168733,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- project_column: &908
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: &903
title: Project Column
type: object
properties:
@@ -169406,7 +168775,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -169485,18 +168854,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- project_column: *908
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: *903
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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -169586,11 +168955,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- project_column: *908
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: *903
+ repository: *858
sender: *4
required:
- action
@@ -169670,11 +169039,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *860
- installation: *861
- organization: *862
- project_column: *908
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: *903
+ repository: *858
sender: *4
required:
- action
@@ -169754,11 +169123,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
+ repository: *858
sender: *4
required:
- action
@@ -169838,18 +169207,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -169951,11 +169320,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
+ repository: *858
sender: *4
required:
- action
@@ -170034,11 +169403,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
+ repository: *858
sender: *4
required:
- action
@@ -170119,8 +169488,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170202,8 +169571,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170285,8 +169654,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170404,8 +169773,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170489,7 +169858,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &913
+ changes: &908
type: object
properties:
archived_at:
@@ -170503,9 +169872,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *861
- organization: *862
- projects_v2_item: &910
+ installation: *856
+ organization: *857
+ projects_v2_item: &905
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -170640,9 +170009,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -170724,9 +170093,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -170807,9 +170176,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -170915,7 +170284,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &911
+ - &906
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -170937,7 +170306,7 @@ x-webhooks:
required:
- id
- name
- - &912
+ - &907
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -170971,8 +170340,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *911
- - *912
+ - *906
+ - *907
required:
- field_value
- type: object
@@ -170988,9 +170357,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -171085,9 +170454,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -171170,10 +170539,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *913
- installation: *861
- organization: *862
- projects_v2_item: *910
+ changes: *908
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -171255,8 +170624,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -171338,14 +170707,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *861
- organization: *862
- projects_v2_status_update: &916
+ installation: *856
+ organization: *857
+ projects_v2_status_update: &911
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *914
- required: *915
+ properties: *909
+ required: *910
sender: *4
required:
- action
@@ -171426,9 +170795,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *861
- organization: *862
- projects_v2_status_update: *916
+ installation: *856
+ organization: *857
+ projects_v2_status_update: *911
sender: *4
required:
- action
@@ -171564,9 +170933,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *861
- organization: *862
- projects_v2_status_update: *916
+ installation: *856
+ organization: *857
+ projects_v2_status_update: *911
sender: *4
required:
- action
@@ -171637,10 +171006,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- repository
@@ -171717,13 +171086,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *887
- enterprise: *860
- installation: *861
- number: &917
+ assignee: *882
+ enterprise: *855
+ installation: *856
+ number: &912
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -174006,7 +173375,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -174088,11 +173457,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -176370,7 +175739,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -176452,11 +175821,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -178734,7 +178103,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -178816,13 +178185,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: &918
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: &913
allOf:
- - *704
+ - *701
- type: object
properties:
allow_auto_merge:
@@ -178884,7 +178253,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -178965,12 +178334,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -179050,11 +178419,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *860
- milestone: *686
- number: *917
- organization: *862
- pull_request: &919
+ enterprise: *855
+ milestone: *683
+ number: *912
+ organization: *857
+ pull_request: &914
title: Pull Request
type: object
properties:
@@ -181317,7 +180686,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -181396,11 +180765,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -183682,7 +183051,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -183806,12 +183175,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -183891,11 +183260,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -186162,7 +185531,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -186242,11 +185611,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *860
- installation: *861
- label: *881
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ label: *876
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -188528,7 +187897,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -188609,10 +187978,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -190892,7 +190261,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -190972,12 +190341,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *860
- milestone: *686
- number: *917
- organization: *862
- pull_request: *919
- repository: *863
+ enterprise: *855
+ milestone: *683
+ number: *912
+ organization: *857
+ pull_request: *914
+ repository: *858
sender: *4
required:
- action
@@ -191056,12 +190425,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -191142,12 +190511,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -191227,12 +190596,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -191598,9 +190967,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
type: object
properties:
@@ -193770,7 +193139,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -193850,7 +193219,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &921
+ comment: &916
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -194135,9 +193504,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
type: object
properties:
@@ -196295,7 +195664,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -196375,11 +195744,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *920
- comment: *921
- enterprise: *860
- installation: *861
- organization: *862
+ changes: *915
+ comment: *916
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
type: object
properties:
@@ -198540,7 +197909,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -198621,9 +197990,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -200796,7 +200165,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
+ repository: *858
review:
description: The review that was affected.
type: object
@@ -201043,9 +200412,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -203099,8 +202468,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
- review: &922
+ repository: *858
+ review: &917
description: The review that was affected.
type: object
properties:
@@ -203333,12 +202702,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -205621,7 +204990,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_reviewer:
title: User
type: object
@@ -205705,12 +205074,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -208000,7 +207369,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -208192,12 +207561,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -210482,7 +209851,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_reviewer:
title: User
type: object
@@ -210567,12 +209936,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -212848,7 +212217,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -213029,9 +212398,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -215206,8 +214575,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
- review: *922
+ repository: *858
+ review: *917
sender: *4
required:
- action
@@ -215287,9 +214656,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -217359,7 +216728,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
thread:
type: object
@@ -217746,9 +217115,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -219804,7 +219173,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
thread:
type: object
@@ -220194,10 +219563,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -222468,7 +221837,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -222550,11 +221919,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *923
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ assignee: *918
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -224837,7 +224206,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -224916,11 +224285,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *860
- installation: *861
- label: *881
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ label: *876
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -227193,7 +226562,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -227274,10 +226643,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -229542,7 +228911,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -229742,7 +229111,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *860
+ enterprise: *855
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -229834,8 +229203,8 @@ x-webhooks:
- url
- author
- committer
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -230410,9 +229779,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
registry_package:
type: object
properties:
@@ -230858,7 +230227,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *904
+ items: *899
summary:
type: string
tag_name:
@@ -230912,7 +230281,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -230990,9 +230359,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
registry_package:
type: object
properties:
@@ -231300,7 +230669,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *904
+ items: *899
summary:
type: string
tag_name:
@@ -231349,7 +230718,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -231426,10 +230795,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- release: &924
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: &919
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -231747,7 +231116,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -231824,11 +231193,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- release: *924
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *919
+ repository: *858
sender: *4
required:
- action
@@ -231945,11 +231314,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *860
- installation: *861
- organization: *862
- release: *924
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *919
+ repository: *858
sender: *4
required:
- action
@@ -232027,9 +231396,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
release:
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
@@ -232351,7 +231720,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -232427,10 +231796,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
- release: &925
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: &920
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -232749,7 +232118,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -232825,11 +232194,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *860
- installation: *861
- organization: *862
- release: *924
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *919
+ repository: *858
sender: *4
required:
- action
@@ -232905,11 +232274,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *860
- installation: *861
- organization: *862
- release: *925
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *920
+ repository: *858
sender: *4
required:
- action
@@ -232985,11 +232354,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- repository_advisory: *756
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ repository_advisory: *753
sender: *4
required:
- action
@@ -233065,11 +232434,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- repository_advisory: *756
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ repository_advisory: *753
sender: *4
required:
- action
@@ -233145,10 +232514,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233225,10 +232594,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233306,10 +232675,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233393,10 +232762,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233508,10 +232877,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233583,10 +232952,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
status:
type: string
@@ -233667,10 +233036,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233747,10 +233116,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233844,10 +233213,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233927,10 +233296,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
repository_ruleset: *190
sender: *4
required:
@@ -234009,10 +233378,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
repository_ruleset: *190
sender: *4
required:
@@ -234091,10 +233460,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
repository_ruleset: *190
changes:
type: object
@@ -234156,16 +233525,16 @@ x-webhooks:
properties:
added:
type: array
- items: *724
+ items: *721
deleted:
type: array
- items: *724
+ items: *721
updated:
type: array
items:
type: object
properties:
- rule: *724
+ rule: *721
changes:
type: object
properties:
@@ -234399,10 +233768,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234480,10 +233849,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234561,7 +233930,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &926
+ alert: &921
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -234682,10 +234051,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234891,10 +234260,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234972,11 +234341,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *926
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *921
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235175,10 +234544,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235256,7 +234625,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &927
+ alert: &922
type: object
properties:
number: *127
@@ -235375,10 +234744,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235456,11 +234825,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235541,11 +234910,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *927
- installation: *861
- location: *928
- organization: *862
- repository: *863
+ alert: *922
+ installation: *856
+ location: *923
+ organization: *857
+ repository: *858
sender: *4
required:
- location
@@ -235783,11 +235152,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235865,11 +235234,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235947,11 +235316,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -236029,12 +235398,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *927
+ alert: *922
assignee: *4
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -236112,11 +235481,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -236242,10 +235611,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *863
- enterprise: *860
- installation: *861
- organization: *862
+ repository: *858
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -236323,11 +235692,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- security_advisory: &929
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ security_advisory: &924
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -236510,11 +235879,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- security_advisory: *929
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ security_advisory: *924
sender: *4
required:
- action
@@ -236587,10 +235956,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -236775,10 +236144,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *419
- enterprise: *860
- installation: *861
- organization: *862
- repository: *467
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *464
sender: *4
required:
- changes
@@ -236856,12 +236225,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: &930
+ sponsorship: &925
type: object
properties:
created_at:
@@ -237162,12 +236531,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- sponsorship
@@ -237255,12 +236624,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- changes
@@ -237337,17 +236706,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &931
+ effective_date: &926
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: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- sponsorship
@@ -237421,7 +236790,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &932
+ changes: &927
type: object
properties:
tier:
@@ -237465,13 +236834,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *931
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ effective_date: *926
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- changes
@@ -237548,13 +236917,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *932
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ changes: *927
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- changes
@@ -237628,10 +236997,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -237714,10 +237083,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -238137,15 +237506,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *860
+ enterprise: *855
id:
description: The unique identifier of the status.
type: integer
- installation: *861
+ installation: *856
name:
type: string
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
sha:
description: The Commit SHA.
@@ -238260,9 +237629,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238352,9 +237721,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238444,9 +237813,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238536,9 +237905,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238615,12 +237984,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- team: &933
+ team: &928
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -238843,9 +238212,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -239303,7 +238672,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -239379,9 +238748,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -239839,7 +239208,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -239916,9 +239285,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -240376,7 +239745,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -240520,9 +239889,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -240980,7 +240349,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- changes
@@ -241058,9 +240427,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -241518,7 +240887,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -241594,10 +240963,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -241670,16 +241039,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *860
+ enterprise: *855
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
ref:
type: string
- repository: *863
+ repository: *858
sender: *4
workflow:
type: string
@@ -241761,10 +241130,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
allOf:
@@ -242001,7 +241370,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242080,10 +241449,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
allOf:
@@ -242343,7 +241712,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242422,10 +241791,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
type: object
@@ -242560,7 +241929,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242639,10 +242008,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
type: object
@@ -242778,7 +242147,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242858,12 +242227,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Workflow Run
type: object
@@ -243862,12 +243231,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Workflow Run
type: object
@@ -244851,12 +244220,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json
index 0af53747a..ae1f4de04 100644
--- a/descriptions/ghec/dereferenced/ghec.deref.json
+++ b/descriptions/ghec/dereferenced/ghec.deref.json
@@ -250894,15 +250894,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -251012,8 +251003,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -251055,8 +251044,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -251320,15 +251307,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -251438,8 +251416,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -251479,8 +251455,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -251710,15 +251684,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -251828,8 +251793,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -251869,8 +251832,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -252124,15 +252085,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -252242,8 +252194,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -252283,8 +252233,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -252375,17 +252323,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-in-org",
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -252405,28 +252353,380 @@
"schema": {
"type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
+ }
+ },
+ "required": [
+ "group_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "delete": {
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/invitations": {
+ "get": {
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-pending-invitations-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
@@ -252456,11 +252756,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -252582,125 +252908,34 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ ]
},
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "team_count": {
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
},
- "updated_at": {
+ "invitation_teams_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
},
- "url": {
+ "invitation_source": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "example": "\"member\""
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
+ "id",
+ "login",
+ "email",
+ "role",
"created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
]
}
},
@@ -252708,49 +252943,37 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "avatar_url": "https://github.com/images/error/other_user_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",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
}
]
}
@@ -252771,19 +252994,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -252805,298 +253030,175 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "integer"
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
+ },
+ {
+ "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
}
}
- },
+ ],
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "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"
- }
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
+ "email": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
+ "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"
+ ]
+ }
},
"examples": {
"default": {
- "value": {
- "author": {
+ "value": [
+ {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -253115,57 +253217,41 @@
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
}
- }
+ ]
}
}
}
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
}
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
"get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -253187,21 +253273,12 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
@@ -253211,323 +253288,73 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
"value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
}
}
}
}
}
+ },
+ "404": {
+ "description": "if user has no team membership"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -253549,44 +253376,38 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "body": "Do you like pineapples?"
+ "role": "maintainer"
}
}
}
@@ -253599,499 +253420,76 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
},
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/external-groups": {
- "get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "operationId": "teams/remove-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -254111,218 +253509,10 @@
"schema": {
"type": "string"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
@@ -254333,27 +253523,30 @@
"responses": {
"204": {
"description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "external-groups"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/invitations": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-pending-invitations-in-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories"
},
"parameters": [
{
@@ -254401,37 +253594,28 @@
"schema": {
"type": "array",
"items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
"type": "object",
"properties": {
"id": {
"type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
+ "format": "int64",
+ "example": 1296269
},
- "email": {
+ "node_id": {
"type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
- "failed_at": {
+ "name": {
"type": "string",
- "nullable": true
+ "example": "Hello-World"
},
- "failed_reason": {
+ "full_name": {
"type": "string",
- "nullable": true
+ "example": "octocat/Hello-World"
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -254555,1011 +253739,182 @@
"url"
]
},
- "team_count": {
- "type": "integer"
+ "private": {
+ "type": "boolean"
},
- "node_id": {
+ "html_url": {
"type": "string",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
},
- "invitation_teams_url": {
+ "description": {
"type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "example": "This your first repo!",
+ "nullable": true
},
- "invitation_source": {
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
"type": "string",
- "example": "\"member\""
- }
- },
- "required": [
- "id",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_id"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1,
- "login": "monalisa",
- "node_id": "MDQ6VXNlcjE=",
- "email": "octocat@github.com",
- "role": "direct_member",
- "created_at": "2016-11-30T06:46:10-08:00",
- "failed_at": "",
- "failed_reason": "",
- "inviter": {
- "login": "other_user",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/other_user_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/other_user",
- "html_url": "https://github.com/other_user",
- "followers_url": "https://api.github.com/users/other_user/followers",
- "following_url": "https://api.github.com/users/other_user/following{/other_user}",
- "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
- "organizations_url": "https://api.github.com/users/other_user/orgs",
- "repos_url": "https://api.github.com/users/other_user/repos",
- "events_url": "https://api.github.com/users/other_user/events{/privacy}",
- "received_events_url": "https://api.github.com/users/other_user/received_events",
- "type": "User",
- "site_admin": false
- },
- "team_count": 2,
- "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
- "invitation_source": "member"
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
- "login": {
+ "assignees_url": {
"type": "string",
- "example": "octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
- "node_id": {
+ "branches_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
- "avatar_url": {
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
- "gravatar_id": {
+ "deployments_url": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
- "url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
- "html_url": {
+ "events_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
},
- "followers_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
- "following_url": {
+ "git_commits_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
- "gists_url": {
+ "git_refs_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
- "starred_url": {
+ "git_tags_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
- "subscriptions_url": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
- "organizations_url": {
+ "merges_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
- "repos_url": {
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
- "events_url": {
+ "statuses_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
- "received_events_url": {
+ "subscribers_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
- "type": {
+ "subscription_url": {
"type": "string",
- "example": "User"
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
- "site_admin": {
- "type": "boolean"
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
- "starred_at": {
+ "teams_url": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
- "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"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "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
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- },
- "422": {
- "description": "Unprocessable Entity if you attempt to add an organization to a team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "delete": {
- "summary": "Remove team membership for a user",
- "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/remove-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/repos": {
- "get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-repos-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
- },
- "node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
- "nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
+ "trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
@@ -598200,1688 +596555,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- },
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -599891,41 +596571,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -599984,10 +596679,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -600017,19 +596715,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -600062,20 +596763,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Create a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-legacy",
+ "operationId": "teams/create-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy"
},
"parameters": [
{
@@ -600086,15 +596787,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -600104,19 +596796,30 @@
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
}
},
"required": [
+ "title",
"body"
]
},
"examples": {
"default": {
"value": {
- "body": "Do you like apples?"
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
}
}
}
@@ -600129,8 +596832,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -600259,13 +596962,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -600275,41 +596978,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -600368,10 +597086,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -600399,19 +597120,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -600436,22 +597160,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/teams/{team_id}/discussions/{discussion_number}": {
"get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-legacy",
+ "operationId": "teams/get-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
},
"parameters": [
{
@@ -600471,15 +597195,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -600488,8 +597203,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -600618,13 +597333,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -600634,41 +597349,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -600727,10 +597457,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -600758,19 +597491,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -600794,20 +597530,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Update a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-legacy",
+ "operationId": "teams/update-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy"
},
"parameters": [
{
@@ -600827,37 +597563,29 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "body": "Do you like pineapples?"
+ "title": "Welcome to our first team post"
}
}
}
@@ -600870,8 +597598,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -601000,13 +597728,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -601016,41 +597744,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -601109,10 +597852,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -601140,19 +597886,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
"updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -601176,20 +597925,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-legacy",
+ "operationId": "teams/delete-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
},
"parameters": [
{
@@ -601209,15 +597958,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -601231,7 +597971,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml
index de485af58..1fe82ed32 100644
--- a/descriptions/ghec/dereferenced/ghec.deref.yaml
+++ b/descriptions/ghec/dereferenced/ghec.deref.yaml
@@ -1029,7 +1029,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &758
+ - &755
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1713,7 +1713,7 @@ paths:
application/json:
schema: *3
application/scim+json:
- schema: &768
+ schema: &765
title: Scim Error
description: Scim Error
type: object
@@ -8897,7 +8897,7 @@ paths:
value:
days: 90
maximum_allowed_days: 365
- '401': &769
+ '401': &766
description: Authorization failure
'404': *6
x-github:
@@ -13108,7 +13108,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &536
+ instances_url: &533
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -13143,7 +13143,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &537
+ dismissed_reason: &534
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -13152,13 +13152,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &538
+ dismissed_comment: &535
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &539
+ rule: &536
type: object
properties:
id:
@@ -13211,7 +13211,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &540
+ tool: &537
type: object
properties:
name: *111
@@ -13221,26 +13221,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *112
- most_recent_instance: &541
+ most_recent_instance: &538
type: object
properties:
- ref: &534
+ ref: &531
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &551
+ analysis_key: &548
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
this includes the workflow filename and job name.
- environment: &552
+ environment: &549
type: string
description: Identifies the variable values associated with
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &553
+ category: &550
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -13254,7 +13254,7 @@ paths:
properties:
text:
type: string
- location: &554
+ location: &551
type: object
description: Describe a region within a file for the alert.
properties:
@@ -13275,7 +13275,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &555
+ items: &552
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -16938,7 +16938,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
- - &596
+ - &593
name: has
in: query
description: |-
@@ -17051,7 +17051,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &597
+ security_advisory: &594
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -17283,14 +17283,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *137
- auto_dismissed_at: &598
+ auto_dismissed_at: &595
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &599
+ dismissal_request: &596
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -20775,7 +20775,7 @@ paths:
- *164
rules:
type: array
- items: &724
+ items: &721
title: Repository Rule
type: object
description: A repository rule.
@@ -20784,7 +20784,7 @@ paths:
- *170
- *171
- *172
- - &722
+ - &719
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -21347,14 +21347,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &736
+ state: &733
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: &737
+ resolution: &734
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -21461,8 +21461,8 @@ paths:
pull request.
'
- oneOf: &738
- - &740
+ oneOf: &735
+ - &737
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -21514,7 +21514,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &741
+ - &738
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -21569,7 +21569,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &742
+ - &739
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -21583,7 +21583,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &743
+ - &740
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -21597,7 +21597,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &744
+ - &741
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -21611,7 +21611,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &745
+ - &742
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -21625,7 +21625,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &746
+ - &743
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -21639,7 +21639,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &747
+ - &744
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -21653,7 +21653,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &748
+ - &745
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -21667,7 +21667,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &749
+ - &746
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -21681,7 +21681,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &750
+ - &747
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -21695,7 +21695,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &751
+ - &748
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -21709,7 +21709,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &752
+ - &749
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -25003,7 +25003,7 @@ paths:
properties:
action:
type: string
- discussion: &878
+ discussion: &873
title: Discussion
description: A Discussion in a repository.
type: object
@@ -25370,7 +25370,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &660
+ properties: &657
id:
type: integer
format: int64
@@ -25747,7 +25747,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &796
+ sub_issues_summary: &793
title: Sub-issues Summary
type: object
properties:
@@ -25767,7 +25767,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &797
+ issue_dependencies_summary: &794
title: Issue Dependencies Summary
type: object
properties:
@@ -25786,7 +25786,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &798
+ items: &795
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -25847,7 +25847,7 @@ paths:
- node_id
- data_type
- value
- required: &661
+ required: &658
- assignee
- closed_at
- comments
@@ -25885,7 +25885,7 @@ paths:
action:
type: string
issue: *220
- comment: &656
+ comment: &653
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -26604,7 +26604,7 @@ paths:
type: string
release:
allOf:
- - &715
+ - &712
title: Release
description: A release.
type: object
@@ -26675,7 +26675,7 @@ paths:
author: *4
assets:
type: array
- items: &716
+ items: &713
title: Release Asset
description: Data related to a release.
type: object
@@ -27254,7 +27254,7 @@ paths:
url:
type: string
format: uri
- user: &808
+ user: &803
title: Public User
description: Public User
type: object
@@ -30559,14 +30559,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &462
+ - &459
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &463
+ - &460
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -30628,7 +30628,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &468
+ '301': &465
description: Moved permanently
content:
application/json:
@@ -30650,7 +30650,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &689
+ - &686
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -30658,7 +30658,7 @@ paths:
schema:
type: boolean
default: false
- - &690
+ - &687
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -30668,7 +30668,7 @@ paths:
type: boolean
default: false
- *227
- - &691
+ - &688
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:
@@ -31150,7 +31150,7 @@ paths:
- url
- subscription_url
examples:
- default: &692
+ default: &689
value:
- id: '1'
repository:
@@ -32267,7 +32267,7 @@ paths:
type: array
items: *155
examples:
- default: &698
+ default: &695
value:
- property_name: environment
value: production
@@ -32317,7 +32317,7 @@ paths:
required:
- properties
examples:
- default: &699
+ default: &696
value:
properties:
- property_name: environment
@@ -33130,7 +33130,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &475
+ items: &472
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -35244,7 +35244,7 @@ paths:
type: array
items: *283
examples:
- default: &811
+ default: &806
value:
total_count: 1
repositories:
@@ -36286,7 +36286,7 @@ paths:
description: Response
content:
application/json:
- schema: &495
+ schema: &492
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -36315,7 +36315,7 @@ paths:
- key_id
- key
examples:
- default: &496
+ default: &493
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -36728,7 +36728,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables
parameters:
- *87
- - &480
+ - &477
name: per_page
description: The number of results per page (max 30). For more information,
see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -37942,12 +37942,12 @@ paths:
required:
- subject_digests
examples:
- default: &839
+ default: &834
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &840
+ withPredicateType: &835
value:
subject_digests:
- sha256:abc123
@@ -38005,7 +38005,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &841
+ default: &836
value:
attestations_subject_digests:
- sha256:abc:
@@ -38354,7 +38354,7 @@ paths:
initiator:
type: string
examples:
- default: &509
+ default: &506
value:
attestations:
- bundle:
@@ -39271,7 +39271,7 @@ paths:
be returned.
in: query
required: false
- schema: &535
+ schema: &532
type: string
description: Severity of a code scanning alert.
enum:
@@ -40325,7 +40325,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &567
+ properties: &564
name:
type: string
description: The name of the machine.
@@ -40367,7 +40367,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &568
+ required: &565
- name
- display_name
- operating_system
@@ -41235,7 +41235,7 @@ paths:
- updated_at
- visibility
examples:
- default: &569
+ default: &566
value:
total_count: 2
secrets:
@@ -41273,7 +41273,7 @@ paths:
description: Response
content:
application/json:
- schema: &570
+ schema: &567
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -41302,7 +41302,7 @@ paths:
- key_id
- key
examples:
- default: &571
+ default: &568
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -41334,7 +41334,7 @@ paths:
application/json:
schema: *327
examples:
- default: &573
+ default: &570
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -43193,7 +43193,7 @@ paths:
description: Response
content:
application/json:
- schema: &602
+ schema: &599
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -43210,7 +43210,7 @@ paths:
- key_id
- key
examples:
- default: &603
+ default: &600
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -43540,7 +43540,7 @@ paths:
subcategory: alert-dismissal-requests
parameters:
- *87
- - &611
+ - &608
name: reviewer
description: Filter alert dismissal requests by the handle of the GitHub user
who reviewed the dismissal request.
@@ -43548,7 +43548,7 @@ paths:
required: false
schema:
type: string
- - &612
+ - &609
name: requester
description: Filter alert dismissal requests by the handle of the GitHub user
who requested the dismissal.
@@ -43556,7 +43556,7 @@ paths:
required: false
schema:
type: string
- - &613
+ - &610
name: time_period
description: |-
The time period to filter by.
@@ -43572,7 +43572,7 @@ paths:
- week
- month
default: month
- - &614
+ - &611
name: request_status
description: Filter alert dismissal requests by status. When specified, only
requests with this status will be returned.
@@ -43597,7 +43597,7 @@ paths:
application/json:
schema:
type: array
- items: &615
+ items: &612
title: Code scanning alert dismissal request
description: Alert dismisal request made by a user asking to dismiss
a code scanning alert.
@@ -43753,7 +43753,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/code-scanning/alerts/1
examples:
- default: &616
+ default: &613
value:
- id: 21
number: 42
@@ -43871,7 +43871,7 @@ paths:
application/json:
schema:
type: array
- items: &617
+ items: &614
title: Dependabot alert dismissal request
description: Alert dismissal request made by a user asking to dismiss
a Dependabot alert.
@@ -43988,7 +43988,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/dependabot/1
examples:
- default: &618
+ default: &615
value:
- id: 21
number: 42
@@ -44090,7 +44090,7 @@ paths:
application/json:
schema:
type: array
- items: &619
+ items: &616
title: Secret scanning alert dismissal request
description: A dismissal request made by a user asking to close
a secret scanning alert in this repository.
@@ -44211,7 +44211,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/secret-scanning/17
examples:
- default: &620
+ default: &617
value:
- id: 21
number: 42
@@ -44556,7 +44556,7 @@ paths:
description: Response
content:
application/json:
- schema: &459
+ schema: &456
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -44637,7 +44637,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &460
+ default: &457
value:
group_id: '123'
group_name: Octocat admins
@@ -44692,7 +44692,7 @@ paths:
description: Response
content:
application/json:
- schema: &457
+ schema: &454
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -44729,7 +44729,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &458
+ default: &455
value:
groups:
- group_id: '123'
@@ -46031,7 +46031,7 @@ paths:
application/json:
schema: *22
examples:
- default: &651
+ default: &648
value:
id: 1
account:
@@ -46256,7 +46256,7 @@ paths:
required: true
content:
application/json:
- schema: &652
+ schema: &649
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -47117,7 +47117,7 @@ paths:
application/json:
schema: *376
examples:
- default: &566
+ default: &563
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -48366,7 +48366,7 @@ paths:
parameters:
- *87
- *382
- - &824
+ - &819
name: repo_name
description: repo_name parameter
in: path
@@ -49692,7 +49692,7 @@ paths:
- nuget
- container
- *87
- - &825
+ - &820
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -49733,7 +49733,7 @@ paths:
default: *388
'403': *29
'401': *25
- '400': &827
+ '400': &822
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -51525,7 +51525,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &914
+ properties: &909
id:
type: number
description: The unique identifier of the status update.
@@ -51573,7 +51573,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &915
+ required: &910
- id
- node_id
- created_at
@@ -51787,7 +51787,7 @@ paths:
content:
oneOf:
- *220
- - &583
+ - &580
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -52016,7 +52016,7 @@ paths:
- review_comment
- self
author_association: *221
- auto_merge: &701
+ auto_merge: &698
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -52391,7 +52391,7 @@ paths:
- updated_at
- project_url
examples:
- default: &844
+ default: &839
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52568,7 +52568,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &845
+ items: &840
type: object
properties:
name:
@@ -52604,7 +52604,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &846
+ iteration_configuration: &841
type: object
description: The configuration for iteration fields.
properties:
@@ -52653,7 +52653,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &847
+ single_select_field: &842
summary: Create a single select field
value:
name: Priority
@@ -52680,7 +52680,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &848
+ iteration_field: &843
summary: Create an iteration field
value:
name: Sprint
@@ -52706,7 +52706,7 @@ paths:
application/json:
schema: *409
examples:
- text_field: &849
+ text_field: &844
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -52715,7 +52715,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &850
+ number_field: &845
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -52724,7 +52724,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &851
+ date_field: &846
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -52733,7 +52733,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &852
+ single_select_field: &847
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52767,7 +52767,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &853
+ iteration_field: &848
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -52813,7 +52813,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization
parameters:
- *405
- - &854
+ - &849
name: field_id
description: The unique identifier of the field.
in: path
@@ -52828,7 +52828,7 @@ paths:
application/json:
schema: *409
examples:
- default: &855
+ default: &850
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -53950,7 +53950,7 @@ paths:
parameters:
- *405
- *87
- - &856
+ - &851
name: view_number
description: The number that identifies the project view.
in: path
@@ -54716,7 +54716,7 @@ paths:
description: Response
content:
application/json:
- schema: &467
+ schema: &464
title: Full Repository
description: Full Repository
type: object
@@ -55109,7 +55109,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &588
+ properties: &585
url:
type: string
format: uri
@@ -55125,7 +55125,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &589
+ required: &586
- url
- key
- name
@@ -55214,7 +55214,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &469
+ default: &466
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -55767,7 +55767,7 @@ paths:
- *87
- *17
- *19
- - &723
+ - &720
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -55982,7 +55982,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *87
- - &725
+ - &722
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
@@ -55994,14 +55994,14 @@ paths:
x-multi-segment: true
- *309
- *105
- - &726
+ - &723
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
- - &727
+ - &724
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -56021,7 +56021,7 @@ paths:
description: Response
content:
application/json:
- schema: &728
+ schema: &725
title: Rule Suites
description: Response
type: array
@@ -56076,7 +56076,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &729
+ default: &726
value:
- id: 21
actor_id: 12
@@ -56120,7 +56120,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *87
- - &730
+ - &727
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -56136,7 +56136,7 @@ paths:
description: Response
content:
application/json:
- schema: &731
+ schema: &728
title: Rule Suite
description: Response
type: object
@@ -56235,7 +56235,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &732
+ default: &729
value:
id: 21
actor_id: 12
@@ -56567,7 +56567,7 @@ paths:
- *110
- *19
- *17
- - &734
+ - &731
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -56577,7 +56577,7 @@ paths:
required: false
schema:
type: string
- - &735
+ - &732
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -56790,7 +56790,7 @@ paths:
application/json:
schema:
type: array
- items: &756
+ items: &753
description: A repository security advisory.
type: object
properties:
@@ -57081,7 +57081,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &757
+ default: &754
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -58090,7 +58090,7 @@ paths:
description: Response
content:
application/json:
- schema: &464
+ schema: &461
title: GroupMapping
description: External Groups to be mapped to a team for membership
type: object
@@ -58136,7 +58136,7 @@ paths:
type: string
nullable: true
examples:
- default: &465
+ default: &462
value:
groups:
- group_id: '123'
@@ -58940,13 +58940,6 @@ paths:
does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -58998,8 +58991,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -59012,7 +59003,7 @@ paths:
- updated_at
- url
examples:
- default: &800
+ default: &797
value:
- author:
login: octocat
@@ -59037,8 +59028,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -59148,8 +59137,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -59260,7 +59247,7 @@ paths:
application/json:
schema: *451
examples:
- default: &801
+ default: &798
value:
author:
login: octocat
@@ -59285,8 +59272,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -59341,410 +59326,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - *87
- - *215
- - *453
- - *110
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &454
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *222
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &802
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- headers:
- Link: *47
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: &455
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- - &456
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *455
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- - *456
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: &803
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - *87
- - *215
- - *453
- - *456
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -59766,9 +59347,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -59811,9 +59392,9 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -59954,7 +59535,7 @@ paths:
description: Response
content:
application/json:
- schema: &461
+ schema: &458
title: Team Membership
description: Team Membership
type: object
@@ -59981,7 +59562,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &804
+ response-if-user-is-a-team-maintainer: &799
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -60044,9 +59625,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- response-if-users-membership-with-team-is-now-pending: &805
+ response-if-users-membership-with-team-is-now-pending: &800
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -60153,14 +59734,14 @@ paths:
parameters:
- *87
- *215
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &806
+ schema: &801
title: Team Repository
description: A team's access to a repository.
type: object
@@ -60731,8 +60312,8 @@ paths:
parameters:
- *87
- *215
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -60779,8 +60360,8 @@ paths:
parameters:
- *87
- *215
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -60813,9 +60394,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *465
+ default: *462
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -60881,7 +60462,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -60926,7 +60507,7 @@ paths:
type: array
items: *312
examples:
- response-if-child-teams-exist: &807
+ response-if-child-teams-exist: &802
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -61080,7 +60661,7 @@ paths:
resources:
type: object
properties:
- core: &466
+ core: &463
title: Rate Limit
type: object
properties:
@@ -61097,21 +60678,21 @@ paths:
- remaining
- reset
- used
- graphql: *466
- search: *466
- code_search: *466
- source_import: *466
- integration_manifest: *466
- code_scanning_upload: *466
- actions_runner_registration: *466
- scim: *466
- dependency_snapshots: *466
- dependency_sbom: *466
- code_scanning_autofix: *466
+ graphql: *463
+ search: *463
+ code_search: *463
+ source_import: *463
+ integration_manifest: *463
+ code_scanning_upload: *463
+ actions_runner_registration: *463
+ scim: *463
+ dependency_snapshots: *463
+ dependency_sbom: *463
+ code_scanning_autofix: *463
required:
- core
- search
- rate: *466
+ rate: *463
required:
- rate
- resources
@@ -61216,14 +60797,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
default-response:
summary: Default response
@@ -61728,7 +61309,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *468
+ '301': *465
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61746,8 +61327,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -62004,10 +61585,10 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
- '307': &470
+ default: *466
+ '307': &467
description: Temporary Redirect
content:
application/json:
@@ -62036,8 +61617,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -62059,7 +61640,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
- '307': *470
+ '307': *467
'404': *6
'409': *118
x-github:
@@ -62083,11 +61664,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- - &487
+ - &484
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -62110,7 +61691,7 @@ paths:
type: integer
artifacts:
type: array
- items: &471
+ items: &468
title: Artifact
description: An artifact
type: object
@@ -62188,7 +61769,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &488
+ default: &485
value:
total_count: 2
artifacts:
@@ -62249,9 +61830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact
parameters:
- - *462
- - *463
- - &472
+ - *459
+ - *460
+ - &469
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -62263,7 +61844,7 @@ paths:
description: Response
content:
application/json:
- schema: *471
+ schema: *468
examples:
default:
value:
@@ -62301,9 +61882,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact
parameters:
- - *462
- - *463
- - *472
+ - *459
+ - *460
+ - *469
responses:
'204':
description: Response
@@ -62327,9 +61908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact
parameters:
- - *462
- - *463
- - *472
+ - *459
+ - *460
+ - *469
- name: archive_format
in: path
required: true
@@ -62343,7 +61924,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': &655
+ '410': &652
description: Gone
content:
application/json:
@@ -62368,14 +61949,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &473
+ schema: &470
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -62408,13 +61989,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *473
+ schema: *470
examples:
selected_actions: *44
responses:
@@ -62443,14 +62024,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &474
+ schema: &471
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -62483,13 +62064,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *474
+ schema: *471
examples:
selected_actions: *46
responses:
@@ -62520,14 +62101,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *475
+ schema: *472
examples:
default:
value:
@@ -62553,11 +62134,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- - &476
+ - &473
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/`. To reference
@@ -62591,7 +62172,7 @@ paths:
description: Response
content:
application/json:
- schema: &477
+ schema: &474
title: Repository actions caches
description: Repository actions caches
type: object
@@ -62633,7 +62214,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &478
+ default: &475
value:
total_count: 1
actions_caches:
@@ -62665,23 +62246,23 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *476
+ - *473
responses:
'200':
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
- default: *478
+ default: *475
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62701,8 +62282,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -62733,9 +62314,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *462
- - *463
- - &479
+ - *459
+ - *460
+ - &476
name: job_id
description: The unique identifier of the job.
in: path
@@ -62747,7 +62328,7 @@ paths:
description: Response
content:
application/json:
- schema: &491
+ schema: &488
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -63054,9 +62635,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *462
- - *463
- - *479
+ - *459
+ - *460
+ - *476
responses:
'302':
description: Response
@@ -63084,9 +62665,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *462
- - *463
- - *479
+ - *459
+ - *460
+ - *476
requestBody:
required: false
content:
@@ -63131,8 +62712,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Status response
@@ -63182,8 +62763,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -63246,8 +62827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -63265,7 +62846,7 @@ paths:
type: integer
secrets:
type: array
- items: &493
+ items: &490
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -63285,7 +62866,7 @@ paths:
- created_at
- updated_at
examples:
- default: &494
+ default: &491
value:
total_count: 2
secrets:
@@ -63318,9 +62899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables
parameters:
- - *462
- - *463
- - *480
+ - *459
+ - *460
+ - *477
- *19
responses:
'200':
@@ -63337,7 +62918,7 @@ paths:
type: integer
variables:
type: array
- items: &497
+ items: &494
title: Actions Variable
type: object
properties:
@@ -63367,7 +62948,7 @@ paths:
- created_at
- updated_at
examples:
- default: &498
+ default: &495
value:
total_count: 2
variables:
@@ -63400,8 +62981,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63410,7 +62991,7 @@ paths:
schema:
type: object
properties:
- enabled: &481
+ enabled: &478
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *60
@@ -63445,8 +63026,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -63457,7 +63038,7 @@ paths:
schema:
type: object
properties:
- enabled: *481
+ enabled: *478
allowed_actions: *60
sha_pinning_required: *61
required:
@@ -63490,14 +63071,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &482
+ schema: &479
type: object
properties:
access_level:
@@ -63515,7 +63096,7 @@ paths:
required:
- access_level
examples:
- default: &483
+ default: &480
value:
access_level: organization
x-github:
@@ -63540,15 +63121,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *482
+ schema: *479
examples:
- default: *483
+ default: *480
responses:
'204':
description: Response
@@ -63572,8 +63153,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63603,8 +63184,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Empty response for successful settings update
@@ -63638,8 +63219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63666,8 +63247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -63701,8 +63282,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63730,8 +63311,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -63762,8 +63343,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63794,8 +63375,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -63827,8 +63408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63857,8 +63438,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Success response
@@ -63898,8 +63479,8 @@ paths:
in: query
schema:
type: string
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -63943,8 +63524,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -63976,8 +63557,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -64051,8 +63632,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'201':
description: Response
@@ -64088,8 +63669,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'201':
description: Response
@@ -64119,8 +63700,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'200':
@@ -64150,8 +63731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'204':
@@ -64178,8 +63759,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'200': *81
@@ -64204,8 +63785,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
requestBody:
required: true
@@ -64254,8 +63835,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
requestBody:
required: true
@@ -64305,8 +63886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
responses:
'200': *290
@@ -64336,8 +63917,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *75
- *291
responses:
@@ -64367,9 +63948,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *462
- - *463
- - &501
+ - *459
+ - *460
+ - &498
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.
@@ -64377,7 +63958,7 @@ paths:
required: false
schema:
type: string
- - &502
+ - &499
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -64385,7 +63966,7 @@ paths:
required: false
schema:
type: string
- - &503
+ - &500
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -64394,7 +63975,7 @@ paths:
required: false
schema:
type: string
- - &504
+ - &501
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
@@ -64421,7 +64002,7 @@ paths:
- pending
- *17
- *19
- - &505
+ - &502
name: created
description: Returns workflow runs created within the given date-time range.
For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -64430,7 +64011,7 @@ paths:
schema:
type: string
format: date-time
- - &484
+ - &481
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -64439,13 +64020,13 @@ paths:
schema:
type: boolean
default: false
- - &506
+ - &503
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &507
+ - &504
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -64468,7 +64049,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &485
+ items: &482
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -64616,7 +64197,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &529
+ properties: &526
id:
type: string
description: SHA for the commit
@@ -64667,7 +64248,7 @@ paths:
- name
- email
nullable: true
- required: &530
+ required: &527
- id
- tree_id
- message
@@ -64714,7 +64295,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &508
+ default: &505
value:
total_count: 1
workflow_runs:
@@ -64950,24 +64531,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *462
- - *463
- - &486
+ - *459
+ - *460
+ - &483
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *484
+ - *481
responses:
'200':
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
- default: &489
+ default: &486
value:
id: 30433642
name: Build
@@ -65208,9 +64789,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'204':
description: Response
@@ -65233,9 +64814,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'200':
description: Response
@@ -65354,9 +64935,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'201':
description: Response
@@ -65389,12 +64970,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
- *17
- *19
- - *487
+ - *484
responses:
'200':
description: Response
@@ -65410,9 +64991,9 @@ paths:
type: integer
artifacts:
type: array
- items: *471
+ items: *468
examples:
- default: *488
+ default: *485
headers:
Link: *47
x-github:
@@ -65436,25 +65017,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *462
- - *463
- - *486
- - &490
+ - *459
+ - *460
+ - *483
+ - &487
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *484
+ - *481
responses:
'200':
description: Response
content:
application/json:
- schema: *485
+ schema: *482
examples:
- default: *489
+ default: *486
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65477,10 +65058,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *462
- - *463
- - *486
- - *490
+ - *459
+ - *460
+ - *483
+ - *487
- *17
- *19
responses:
@@ -65498,9 +65079,9 @@ paths:
type: integer
jobs:
type: array
- items: *491
+ items: *488
examples:
- default: &492
+ default: &489
value:
total_count: 1
jobs:
@@ -65613,10 +65194,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *462
- - *463
- - *486
- - *490
+ - *459
+ - *460
+ - *483
+ - *487
responses:
'302':
description: Response
@@ -65644,9 +65225,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'202':
description: Response
@@ -65679,9 +65260,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: true
content:
@@ -65748,9 +65329,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'202':
description: Response
@@ -65783,9 +65364,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
- 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
@@ -65815,9 +65396,9 @@ paths:
type: integer
jobs:
type: array
- items: *491
+ items: *488
examples:
- default: *492
+ default: *489
headers:
Link: *47
x-github:
@@ -65842,9 +65423,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'302':
description: Response
@@ -65871,9 +65452,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'204':
description: Response
@@ -65900,9 +65481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'200':
description: Response
@@ -65962,7 +65543,7 @@ paths:
items:
type: object
properties:
- type: &621
+ type: &618
type: string
description: The type of reviewer.
enum:
@@ -66047,9 +65628,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: true
content:
@@ -66096,7 +65677,7 @@ paths:
application/json:
schema:
type: array
- items: &606
+ items: &603
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -66202,7 +65783,7 @@ paths:
- created_at
- updated_at
examples:
- default: &607
+ default: &604
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -66258,9 +65839,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: false
content:
@@ -66304,9 +65885,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
requestBody:
required: false
content:
@@ -66360,9 +65941,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *462
- - *463
- - *486
+ - *459
+ - *460
+ - *483
responses:
'200':
description: Response
@@ -66499,8 +66080,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -66518,9 +66099,9 @@ paths:
type: integer
secrets:
type: array
- items: *493
+ items: *490
examples:
- default: *494
+ default: *491
headers:
Link: *47
x-github:
@@ -66545,16 +66126,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *495
+ schema: *492
examples:
- default: *496
+ default: *493
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66576,17 +66157,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: &634
+ default: &631
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -66612,8 +66193,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
requestBody:
required: true
@@ -66671,8 +66252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'204':
@@ -66698,9 +66279,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables
parameters:
- - *462
- - *463
- - *480
+ - *459
+ - *460
+ - *477
- *19
responses:
'200':
@@ -66717,9 +66298,9 @@ paths:
type: integer
variables:
type: array
- items: *497
+ items: *494
examples:
- default: *498
+ default: *495
headers:
Link: *47
x-github:
@@ -66742,8 +66323,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -66795,17 +66376,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
responses:
'200':
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &635
+ default: &632
value:
name: USERNAME
value: octocat
@@ -66831,8 +66412,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
requestBody:
required: true
@@ -66875,8 +66456,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
responses:
'204':
@@ -66902,8 +66483,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -66921,7 +66502,7 @@ paths:
type: integer
workflows:
type: array
- items: &499
+ items: &496
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -67028,9 +66609,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow
parameters:
- - *462
- - *463
- - &500
+ - *459
+ - *460
+ - &497
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -67045,7 +66626,7 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
default:
value:
@@ -67078,9 +66659,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'204':
description: Response
@@ -67105,9 +66686,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'204':
description: Response
@@ -67158,9 +66739,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'204':
description: Response
@@ -67187,19 +66768,19 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *462
- - *463
+ - *459
+ - *460
+ - *497
+ - *498
+ - *499
- *500
- *501
+ - *17
+ - *19
- *502
+ - *481
- *503
- *504
- - *17
- - *19
- - *505
- - *484
- - *506
- - *507
responses:
'200':
description: Response
@@ -67215,9 +66796,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *485
+ items: *482
examples:
- default: *508
+ default: *505
headers:
Link: *47
x-github:
@@ -67250,9 +66831,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage
parameters:
- - *462
- - *463
- - *500
+ - *459
+ - *460
+ - *497
responses:
'200':
description: Response
@@ -67313,8 +66894,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *110
- *17
- *108
@@ -67478,8 +67059,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -67516,8 +67097,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: assignee
in: path
required: true
@@ -67553,8 +67134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -67666,8 +67247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *108
- *109
@@ -67724,7 +67305,7 @@ paths:
initiator:
type: string
examples:
- default: *509
+ default: *506
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67744,8 +67325,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -67753,7 +67334,7 @@ paths:
application/json:
schema:
type: array
- items: &510
+ items: &507
title: Autolink reference
description: An autolink reference.
type: object
@@ -67807,8 +67388,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -67847,9 +67428,9 @@ paths:
description: response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: &511
+ default: &508
value:
id: 1
key_prefix: TICKET-
@@ -67880,9 +67461,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *462
- - *463
- - &512
+ - *459
+ - *460
+ - &509
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -67894,9 +67475,9 @@ paths:
description: Response
content:
application/json:
- schema: *510
+ schema: *507
examples:
- default: *511
+ default: *508
'404': *6
x-github:
githubCloudOnly: false
@@ -67916,9 +67497,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *462
- - *463
- - *512
+ - *459
+ - *460
+ - *509
responses:
'204':
description: Response
@@ -67942,8 +67523,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response if Dependabot is enabled
@@ -67991,8 +67572,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -68013,8 +67594,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -68034,8 +67615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -68073,7 +67654,7 @@ paths:
- url
protected:
type: boolean
- protection: &514
+ protection: &511
title: Branch Protection
description: Branch Protection
type: object
@@ -68115,7 +67696,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &517
+ enforce_admins: &514
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -68130,7 +67711,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &519
+ required_pull_request_reviews: &516
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -68206,7 +67787,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &516
+ restrictions: &513
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -68483,9 +68064,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch
parameters:
- - *462
- - *463
- - &515
+ - *459
+ - *460
+ - &512
name: branch
description: The name of the branch. Cannot contain wildcard characters. To
use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql).
@@ -68499,14 +68080,14 @@ paths:
description: Response
content:
application/json:
- schema: &525
+ schema: &522
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &579
+ commit: &576
title: Commit
description: Commit
type: object
@@ -68540,7 +68121,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &513
+ properties: &510
name:
type: string
example: '"Chris Wanstrath"'
@@ -68556,7 +68137,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *513
+ properties: *510
nullable: true
message:
type: string
@@ -68577,7 +68158,7 @@ paths:
required:
- sha
- url
- verification: &641
+ verification: &638
title: Verification
type: object
properties:
@@ -68647,7 +68228,7 @@ paths:
type: integer
files:
type: array
- items: &592
+ items: &589
title: Diff Entry
description: Diff Entry
type: object
@@ -68731,7 +68312,7 @@ paths:
- self
protected:
type: boolean
- protection: *514
+ protection: *511
protection_url:
type: string
format: uri
@@ -68838,7 +68419,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *468
+ '301': *465
'404': *6
x-github:
githubCloudOnly: false
@@ -68860,15 +68441,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -69062,9 +68643,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -69319,7 +68900,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &522
+ required_status_checks: &519
title: Status Check Policy
description: Status Check Policy
type: object
@@ -69471,7 +69052,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *516
+ restrictions: *513
required_conversation_resolution:
type: object
properties:
@@ -69583,9 +69164,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -69610,17 +69191,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &518
+ default: &515
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -69642,17 +69223,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69671,9 +69252,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -69698,17 +69279,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: &520
+ default: &517
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -69804,9 +69385,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -69904,9 +69485,9 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: *520
+ default: *517
'422': *15
x-github:
githubCloudOnly: false
@@ -69927,9 +69508,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -69956,17 +69537,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &521
+ default: &518
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -69989,17 +69570,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *521
+ default: *518
'404': *6
x-github:
githubCloudOnly: false
@@ -70019,9 +69600,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -70046,17 +69627,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
- default: &523
+ default: &520
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -70082,9 +69663,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70136,9 +69717,9 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
- default: *523
+ default: *520
'404': *6
'422': *15
x-github:
@@ -70160,9 +69741,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -70186,9 +69767,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -70222,9 +69803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70291,9 +69872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70357,9 +69938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
content:
application/json:
@@ -70425,15 +70006,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
default:
value:
@@ -70524,9 +70105,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'204':
description: Response
@@ -70549,9 +70130,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -70561,7 +70142,7 @@ paths:
type: array
items: *5
examples:
- default: &524
+ default: &521
value:
- id: 1
slug: octoapp
@@ -70618,9 +70199,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -70654,7 +70235,7 @@ paths:
type: array
items: *5
examples:
- default: *524
+ default: *521
'422': *15
x-github:
githubCloudOnly: false
@@ -70675,9 +70256,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -70711,7 +70292,7 @@ paths:
type: array
items: *5
examples:
- default: *524
+ default: *521
'422': *15
x-github:
githubCloudOnly: false
@@ -70732,9 +70313,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -70768,7 +70349,7 @@ paths:
type: array
items: *5
examples:
- default: *524
+ default: *521
'422': *15
x-github:
githubCloudOnly: false
@@ -70790,9 +70371,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -70822,9 +70403,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70883,9 +70464,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: false
content:
@@ -70944,9 +70525,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
content:
application/json:
@@ -71005,9 +70586,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
responses:
'200':
description: Response
@@ -71041,9 +70622,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71101,9 +70682,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71161,9 +70742,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71223,9 +70804,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
requestBody:
required: true
content:
@@ -71247,7 +70828,7 @@ paths:
description: Response
content:
application/json:
- schema: *525
+ schema: *522
examples:
default:
value:
@@ -71361,8 +70942,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *103
- *104
- *105
@@ -71398,8 +70979,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_request_number
in: path
required: true
@@ -71472,8 +71053,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *103
- *104
- *105
@@ -71513,8 +71094,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_request_number
in: path
required: true
@@ -71584,8 +71165,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_request_number
in: path
required: true
@@ -71656,8 +71237,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: bypass_response_id
in: path
required: true
@@ -71690,8 +71271,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -71970,7 +71551,7 @@ paths:
description: Response
content:
application/json:
- schema: &526
+ schema: &523
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -72090,7 +71671,7 @@ paths:
check.
type: array
items: *225
- deployment: &867
+ deployment: &862
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -72370,9 +71951,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run
parameters:
- - *462
- - *463
- - &527
+ - *459
+ - *460
+ - &524
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -72384,9 +71965,9 @@ paths:
description: Response
content:
application/json:
- schema: *526
+ schema: *523
examples:
- default: &528
+ default: &525
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -72486,9 +72067,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run
parameters:
- - *462
- - *463
- - *527
+ - *459
+ - *460
+ - *524
requestBody:
required: true
content:
@@ -72728,9 +72309,9 @@ paths:
description: Response
content:
application/json:
- schema: *526
+ schema: *523
examples:
- default: *528
+ default: *525
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72750,9 +72331,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations
parameters:
- - *462
- - *463
- - *527
+ - *459
+ - *460
+ - *524
- *17
- *19
responses:
@@ -72847,9 +72428,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
parameters:
- - *462
- - *463
- - *527
+ - *459
+ - *460
+ - *524
responses:
'201':
description: Response
@@ -72893,8 +72474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -72916,7 +72497,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &531
+ schema: &528
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -73002,12 +72583,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &898
+ head_commit: &893
title: Simple Commit
description: A commit.
type: object
- properties: *529
- required: *530
+ properties: *526
+ required: *527
latest_check_runs_count:
type: integer
check_runs_url:
@@ -73035,7 +72616,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &532
+ default: &529
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -73326,9 +72907,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73347,8 +72928,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -73657,9 +73238,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite
parameters:
- - *462
- - *463
- - &533
+ - *459
+ - *460
+ - &530
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -73671,9 +73252,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73696,17 +73277,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *462
- - *463
- - *533
- - &585
+ - *459
+ - *460
+ - *530
+ - &582
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &586
+ - &583
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -73745,9 +73326,9 @@ paths:
type: integer
check_runs:
type: array
- items: *526
+ items: *523
examples:
- default: &587
+ default: &584
value:
total_count: 1
check_runs:
@@ -73849,9 +73430,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
parameters:
- - *462
- - *463
- - *533
+ - *459
+ - *460
+ - *530
responses:
'201':
description: Response
@@ -73884,21 +73465,21 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *316
- *317
- *19
- *17
- - &549
+ - &546
name: ref
description: The Git reference for the results you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
in: query
required: false
- schema: *534
- - &550
+ schema: *531
+ - &547
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -73929,7 +73510,7 @@ paths:
be returned.
in: query
required: false
- schema: *535
+ schema: *532
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -73953,7 +73534,7 @@ paths:
updated_at: *135
url: *132
html_url: *133
- instances_url: *536
+ instances_url: *533
state: *113
fixed_at: *137
dismissed_by:
@@ -73964,11 +73545,11 @@ paths:
required: *21
nullable: true
dismissed_at: *136
- dismissed_reason: *537
- dismissed_comment: *538
- rule: *539
- tool: *540
- most_recent_instance: *541
+ dismissed_reason: *534
+ dismissed_comment: *535
+ rule: *536
+ tool: *537
+ most_recent_instance: *538
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -74094,7 +73675,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &542
+ '403': &539
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -74121,9 +73702,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *462
- - *463
- - &543
+ - *459
+ - *460
+ - &540
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -74137,7 +73718,7 @@ paths:
description: Response
content:
application/json:
- schema: &544
+ schema: &541
type: object
properties:
number: *127
@@ -74145,7 +73726,7 @@ paths:
updated_at: *135
url: *132
html_url: *133
- instances_url: *536
+ instances_url: *533
state: *113
fixed_at: *137
dismissed_by:
@@ -74156,8 +73737,8 @@ paths:
required: *21
nullable: true
dismissed_at: *136
- dismissed_reason: *537
- dismissed_comment: *538
+ dismissed_reason: *534
+ dismissed_comment: *535
rule:
type: object
properties:
@@ -74211,8 +73792,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *540
- most_recent_instance: *541
+ tool: *537
+ most_recent_instance: *538
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -74311,7 +73892,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74331,9 +73912,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
requestBody:
required: true
content:
@@ -74348,8 +73929,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *537
- dismissed_comment: *538
+ dismissed_reason: *534
+ dismissed_comment: *535
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -74377,7 +73958,7 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -74453,7 +74034,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &548
+ '403': &545
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -74480,15 +74061,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
responses:
'200':
description: Response
content:
application/json:
- schema: &545
+ schema: &542
type: object
properties:
status:
@@ -74514,13 +74095,13 @@ paths:
- description
- started_at
examples:
- default: &546
+ default: &543
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &547
+ '400': &544
description: Bad Request
content:
application/json:
@@ -74531,7 +74112,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': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74556,29 +74137,29 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
responses:
'200':
description: OK
content:
application/json:
- schema: *545
+ schema: *542
examples:
- default: *546
+ default: *543
'202':
description: Accepted
content:
application/json:
- schema: *545
+ schema: *542
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *547
+ '400': *544
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -74610,9 +74191,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
requestBody:
required: false
content:
@@ -74657,8 +74238,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *547
- '403': *548
+ '400': *544
+ '403': *545
'404': *6
'422':
description: Unprocessable Entity
@@ -74682,13 +74263,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
- *19
- *17
- - *549
- - *550
+ - *546
+ - *547
responses:
'200':
description: Response
@@ -74699,10 +74280,10 @@ paths:
items:
type: object
properties:
- ref: *534
- analysis_key: *551
- environment: *552
- category: *553
+ ref: *531
+ analysis_key: *548
+ environment: *549
+ category: *550
state:
type: string
description: State of a code scanning alert instance.
@@ -74717,7 +74298,7 @@ paths:
properties:
text:
type: string
- location: *554
+ location: *551
html_url:
type: string
classifications:
@@ -74725,7 +74306,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: *555
+ items: *552
examples:
default:
value:
@@ -74764,7 +74345,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74798,25 +74379,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *316
- *317
- *19
- *17
- - *550
+ - *547
- name: ref
in: query
description: The Git reference for the analyses you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *534
+ schema: *531
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &556
+ schema: &553
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -74837,23 +74418,23 @@ paths:
application/json:
schema:
type: array
- items: &557
+ items: &554
type: object
properties:
- ref: *534
- commit_sha: &565
+ ref: *531
+ commit_sha: &562
description: The SHA of the commit to which the analysis you
are uploading relates.
type: string
minLength: 40
maxLength: 40
pattern: "^[0-9a-fA-F]+$"
- analysis_key: *551
+ analysis_key: *548
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *553
+ category: *550
error:
type: string
example: error reading field xyz
@@ -74877,8 +74458,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *556
- tool: *540
+ sarif_id: *553
+ tool: *537
deletable:
type: boolean
warning:
@@ -74939,7 +74520,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -74975,8 +74556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -74989,7 +74570,7 @@ paths:
description: Response
content:
application/json:
- schema: *557
+ schema: *554
examples:
response:
summary: application/json response
@@ -75043,7 +74624,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *542
+ '403': *539
'404': *6
'422':
description: Response if analysis could not be processed
@@ -75130,8 +74711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -75184,7 +74765,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': *548
+ '403': *545
'404': *6
'503': *195
x-github:
@@ -75206,8 +74787,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -75215,7 +74796,7 @@ paths:
application/json:
schema:
type: array
- items: &558
+ items: &555
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -75326,7 +74907,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': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -75355,8 +74936,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: language
in: path
description: The language of the CodeQL database.
@@ -75368,7 +74949,7 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
default:
value:
@@ -75400,9 +74981,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': &594
+ '302': &591
description: Found
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -75424,8 +75005,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: language
in: path
description: The language of the CodeQL database.
@@ -75435,7 +75016,7 @@ paths:
responses:
'204':
description: Response
- '403': *548
+ '403': *545
'404': *6
'503': *195
x-github:
@@ -75463,8 +75044,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -75473,7 +75054,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &559
+ language: &556
type: string
description: The language targeted by the CodeQL query
enum:
@@ -75553,7 +75134,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &563
+ schema: &560
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -75563,7 +75144,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *119
actor: *4
- query_language: *559
+ query_language: *556
query_pack_url:
type: string
description: The download url for the query pack.
@@ -75610,7 +75191,7 @@ paths:
items:
type: object
properties:
- repository: &560
+ repository: &557
title: Repository Identifier
description: Repository Identifier
type: object
@@ -75646,7 +75227,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &564
+ analysis_status: &561
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -75678,7 +75259,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &561
+ access_mismatch_repos: &558
type: object
properties:
repository_count:
@@ -75692,7 +75273,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: *560
+ items: *557
required:
- repository_count
- repositories
@@ -75714,8 +75295,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *561
- over_limit_repos: *561
+ no_codeql_db_repos: *558
+ over_limit_repos: *558
required:
- access_mismatch_repos
- not_found_repos
@@ -75731,7 +75312,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &562
+ value: &559
summary: Default response
value:
id: 1
@@ -75877,10 +75458,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *562
+ value: *559
repository_lists:
summary: Response for a successful variant analysis submission
- value: *562
+ value: *559
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -75908,8 +75489,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -75921,9 +75502,9 @@ paths:
description: Response
content:
application/json:
- schema: *563
+ schema: *560
examples:
- default: *562
+ default: *559
'404': *6
'503': *195
x-github:
@@ -75946,7 +75527,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis
parameters:
- - *462
+ - *459
- name: repo
in: path
description: The name of the controller repository.
@@ -75981,7 +75562,7 @@ paths:
type: object
properties:
repository: *119
- analysis_status: *564
+ analysis_status: *561
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -76106,8 +75687,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -76192,7 +75773,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *542
+ '403': *539
'404': *6
'503': *195
x-github:
@@ -76213,8 +75794,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -76306,7 +75887,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *548
+ '403': *545
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -76377,8 +75958,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -76386,7 +75967,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *565
+ commit_sha: *562
ref:
type: string
description: |-
@@ -76444,7 +76025,7 @@ paths:
schema:
type: object
properties:
- id: *556
+ id: *553
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -76458,7 +76039,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': *548
+ '403': *545
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -76481,8 +76062,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -76528,7 +76109,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': *542
+ '403': *539
'404':
description: Not Found if the sarif id does not match any upload
'503': *195
@@ -76553,8 +76134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -76635,8 +76216,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -76756,8 +76337,8 @@ paths:
parameters:
- *17
- *19
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -77071,8 +76652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -77137,7 +76718,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -77145,7 +76726,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'400': *14
'401': *25
'403': *29
@@ -77174,8 +76755,8 @@ paths:
parameters:
- *17
- *19
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -77239,8 +76820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -77275,14 +76856,14 @@ paths:
type: integer
machines:
type: array
- items: &814
+ items: &809
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *567
- required: *568
+ properties: *564
+ required: *565
examples:
- default: &815
+ default: &810
value:
total_count: 2
machines:
@@ -77322,8 +76903,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -77407,8 +76988,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -77474,8 +77055,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -77493,7 +77074,7 @@ paths:
type: integer
secrets:
type: array
- items: &572
+ items: &569
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -77513,7 +77094,7 @@ paths:
- created_at
- updated_at
examples:
- default: *569
+ default: *566
headers:
Link: *47
x-github:
@@ -77536,16 +77117,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *570
+ schema: *567
examples:
- default: *571
+ default: *568
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -77565,17 +77146,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *572
+ schema: *569
examples:
- default: *573
+ default: *570
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -77595,8 +77176,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
requestBody:
required: true
@@ -77649,8 +77230,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'204':
@@ -77679,8 +77260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -77722,7 +77303,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &574
+ properties: &571
login:
type: string
example: octocat
@@ -77815,7 +77396,7 @@ paths:
user_view_type:
type: string
example: public
- required: &575
+ required: &572
- avatar_url
- events_url
- followers_url
@@ -77889,8 +77470,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
responses:
'204':
@@ -77937,8 +77518,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
requestBody:
required: false
@@ -77965,7 +77546,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &654
+ schema: &651
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -78194,8 +77775,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
responses:
'204':
@@ -78227,8 +77808,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *142
responses:
'200':
@@ -78249,8 +77830,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *574
- required: *575
+ properties: *571
+ required: *572
nullable: true
required:
- permission
@@ -78305,8 +77886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -78316,7 +77897,7 @@ paths:
application/json:
schema:
type: array
- items: &576
+ items: &573
title: Commit Comment
description: Commit Comment
type: object
@@ -78374,7 +77955,7 @@ paths:
- created_at
- updated_at
examples:
- default: &581
+ default: &578
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78433,17 +78014,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'200':
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: &582
+ default: &579
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78500,8 +78081,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -78524,7 +78105,7 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
default:
value:
@@ -78575,8 +78156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'204':
@@ -78598,8 +78179,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -78626,7 +78207,7 @@ paths:
application/json:
schema:
type: array
- items: &577
+ items: &574
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -78669,7 +78250,7 @@ paths:
- content
- created_at
examples:
- default: &658
+ default: &655
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78714,8 +78295,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -78748,9 +78329,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: &578
+ default: &575
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78779,9 +78360,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -78803,10 +78384,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- - &659
+ - &656
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -78861,8 +78442,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -78918,9 +78499,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *576
examples:
- default: &708
+ default: &705
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -79014,9 +78595,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit
parameters:
- - *462
- - *463
- - &580
+ - *459
+ - *460
+ - &577
name: commit_sha
description: The SHA of the commit.
in: path
@@ -79088,9 +78669,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
- *17
- *19
responses:
@@ -79100,9 +78681,9 @@ paths:
application/json:
schema:
type: array
- items: *576
+ items: *573
examples:
- default: *581
+ default: *578
headers:
Link: *47
x-github:
@@ -79130,9 +78711,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
requestBody:
required: true
content:
@@ -79167,9 +78748,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *582
+ default: *579
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -79197,9 +78778,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
- *17
- *19
responses:
@@ -79209,9 +78790,9 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *580
examples:
- default: &700
+ default: &697
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -79748,11 +79329,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *19
- *17
- - &584
+ - &581
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)"
@@ -79767,9 +79348,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: &685
+ default: &682
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -79882,11 +79463,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *462
- - *463
- - *584
- - *585
- - *586
+ - *459
+ - *460
+ - *581
+ - *582
+ - *583
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -79920,9 +79501,9 @@ paths:
type: integer
check_runs:
type: array
- items: *526
+ items: *523
examples:
- default: *587
+ default: *584
headers:
Link: *47
x-github:
@@ -79947,9 +79528,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *462
- - *463
- - *584
+ - *459
+ - *460
+ - *581
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -79957,7 +79538,7 @@ paths:
schema:
type: integer
example: 1
- - *585
+ - *582
- *17
- *19
responses:
@@ -79975,7 +79556,7 @@ paths:
type: integer
check_suites:
type: array
- items: *531
+ items: *528
examples:
default:
value:
@@ -80175,9 +79756,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *462
- - *463
- - *584
+ - *459
+ - *460
+ - *581
- *17
- *19
responses:
@@ -80375,9 +79956,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *462
- - *463
- - *584
+ - *459
+ - *460
+ - *581
- *17
- *19
responses:
@@ -80387,7 +79968,7 @@ paths:
application/json:
schema:
type: array
- items: &761
+ items: &758
title: Status
description: The status of a commit.
type: object
@@ -80468,7 +80049,7 @@ paths:
site_admin: false
headers:
Link: *47
- '301': *468
+ '301': *465
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80496,8 +80077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -80526,20 +80107,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *588
- required: *589
+ properties: *585
+ required: *586
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &590
+ properties: &587
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &591
+ required: &588
- url
- html_url
nullable: true
@@ -80553,26 +80134,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
readme:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *590
- required: *591
+ properties: *587
+ required: *588
nullable: true
required:
- code_of_conduct
@@ -80699,8 +80280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *19
- *17
- name: basehead
@@ -80743,8 +80324,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *579
- merge_base_commit: *579
+ base_commit: *576
+ merge_base_commit: *576
status:
type: string
enum:
@@ -80764,10 +80345,10 @@ paths:
example: 6
commits:
type: array
- items: *579
+ items: *576
files:
type: array
- items: *592
+ items: *589
required:
- url
- html_url
@@ -81053,8 +80634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: path
description: path parameter
in: path
@@ -81197,7 +80778,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &593
+ response-if-content-is-a-file: &590
summary: Response if content is a file
value:
type: file
@@ -81329,7 +80910,7 @@ paths:
- size
- type
- url
- - &713
+ - &710
title: Content File
description: Content File
type: object
@@ -81530,7 +81111,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *593
+ response-if-content-is-a-file: *590
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -81599,7 +81180,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *594
+ '302': *591
'304': *37
x-github:
githubCloudOnly: false
@@ -81622,8 +81203,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: path
description: path parameter
in: path
@@ -81716,7 +81297,7 @@ paths:
description: Response
content:
application/json:
- schema: &595
+ schema: &592
title: File Commit
description: File Commit
type: object
@@ -81868,7 +81449,7 @@ paths:
description: Response
content:
application/json:
- schema: *595
+ schema: *592
examples:
example-for-creating-a-file:
value:
@@ -81922,7 +81503,7 @@ paths:
schema:
oneOf:
- *3
- - &636
+ - &633
description: Repository rule violation was detected
type: object
properties:
@@ -81943,7 +81524,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &753
+ placeholder_id: &750
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -81975,8 +81556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: path
description: path parameter
in: path
@@ -82037,7 +81618,7 @@ paths:
description: Response
content:
application/json:
- schema: *595
+ schema: *592
examples:
default:
value:
@@ -82092,8 +81673,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -82216,8 +81797,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *332
- *333
- *334
@@ -82229,7 +81810,7 @@ paths:
schema:
type: string
- *336
- - *596
+ - *593
- *337
- *338
- *110
@@ -82250,7 +81831,7 @@ paths:
application/json:
schema:
type: array
- items: &600
+ items: &597
type: object
description: A Dependabot alert.
properties:
@@ -82296,7 +81877,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *597
+ security_advisory: *594
security_vulnerability: *131
url: *132
html_url: *133
@@ -82327,8 +81908,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *137
- auto_dismissed_at: *598
- dismissal_request: *599
+ auto_dismissed_at: *595
+ dismissal_request: *596
required:
- number
- state
@@ -82558,9 +82139,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *462
- - *463
- - &601
+ - *459
+ - *460
+ - &598
name: alert_number
in: path
description: |-
@@ -82575,7 +82156,7 @@ paths:
description: Response
content:
application/json:
- schema: *600
+ schema: *597
examples:
default:
value:
@@ -82688,9 +82269,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *462
- - *463
- - *601
+ - *459
+ - *460
+ - *598
requestBody:
required: true
content:
@@ -82735,7 +82316,7 @@ paths:
description: Response
content:
application/json:
- schema: *600
+ schema: *597
examples:
default:
value:
@@ -82864,8 +82445,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -82883,7 +82464,7 @@ paths:
type: integer
secrets:
type: array
- items: &604
+ items: &601
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -82936,16 +82517,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *602
+ schema: *599
examples:
- default: *603
+ default: *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82965,15 +82546,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
default:
value:
@@ -82999,8 +82580,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
requestBody:
required: true
@@ -83053,8 +82634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *293
responses:
'204':
@@ -83077,8 +82658,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -83238,8 +82819,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -83478,8 +83059,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -83554,7 +83135,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &605
+ metadata: &602
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -83587,7 +83168,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *605
+ metadata: *602
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -83600,7 +83181,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *605
+ metadata: *602
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -83729,8 +83310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -83770,9 +83351,9 @@ paths:
application/json:
schema:
type: array
- items: *606
+ items: *603
examples:
- default: *607
+ default: *604
headers:
Link: *47
x-github:
@@ -83838,8 +83419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -83920,7 +83501,7 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
simple-example:
summary: Simple example
@@ -83993,9 +83574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment
parameters:
- - *462
- - *463
- - &608
+ - *459
+ - *460
+ - &605
name: deployment_id
description: deployment_id parameter
in: path
@@ -84007,7 +83588,7 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
default:
value:
@@ -84072,9 +83653,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
responses:
'204':
description: Response
@@ -84096,9 +83677,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
- *17
- *19
responses:
@@ -84108,7 +83689,7 @@ paths:
application/json:
schema:
type: array
- items: &609
+ items: &606
title: Deployment Status
description: The status of a deployment.
type: object
@@ -84269,9 +83850,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
requestBody:
required: true
content:
@@ -84346,9 +83927,9 @@ paths:
description: Response
content:
application/json:
- schema: *609
+ schema: *606
examples:
- default: &610
+ default: &607
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -84404,9 +83985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status
parameters:
- - *462
- - *463
- - *608
+ - *459
+ - *460
+ - *605
- name: status_id
in: path
required: true
@@ -84417,9 +83998,9 @@ paths:
description: Response
content:
application/json:
- schema: *609
+ schema: *606
examples:
- default: *610
+ default: *607
'404': *6
x-github:
githubCloudOnly: false
@@ -84446,12 +84027,12 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
+ - *608
+ - *609
+ - *610
- *611
- - *612
- - *613
- - *614
- *17
- *19
responses:
@@ -84461,9 +84042,9 @@ paths:
application/json:
schema:
type: array
- items: *615
+ items: *612
examples:
- default: *616
+ default: *613
'404': *6
'403': *29
'500': *40
@@ -84487,8 +84068,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84500,7 +84081,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *615
+ schema: *612
examples:
default:
value:
@@ -84556,8 +84137,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84616,12 +84197,12 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
+ - *608
+ - *609
+ - *610
- *611
- - *612
- - *613
- - *614
- *17
- *19
responses:
@@ -84631,9 +84212,9 @@ paths:
application/json:
schema:
type: array
- items: *617
+ items: *614
examples:
- default: *618
+ default: *615
'404': *6
'403': *29
'500': *40
@@ -84657,8 +84238,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84670,7 +84251,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *617
+ schema: *614
examples:
default:
value:
@@ -84721,8 +84302,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84760,7 +84341,7 @@ paths:
description: The created dismissal request.
content:
application/json:
- schema: *617
+ schema: *614
examples:
default:
value:
@@ -84811,8 +84392,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84883,8 +84464,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84917,8 +84498,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *103
- *104
- *105
@@ -84932,9 +84513,9 @@ paths:
application/json:
schema:
type: array
- items: *619
+ items: *616
examples:
- default: *620
+ default: *617
'404': *6
'403': *29
'500': *40
@@ -84959,8 +84540,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -84972,7 +84553,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *619
+ schema: *616
examples:
default:
value:
@@ -85030,8 +84611,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: alert_number
in: path
required: true
@@ -85100,8 +84681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -85158,8 +84739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -85176,7 +84757,7 @@ paths:
type: integer
environments:
type: array
- items: &622
+ items: &619
title: Environment
description: Details of a deployment environment
type: object
@@ -85228,7 +84809,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &624
+ wait_timer: &621
type: integer
example: 30
description: The amount of time to delay a job after
@@ -85265,7 +84846,7 @@ paths:
items:
type: object
properties:
- type: *621
+ type: *618
reviewer:
anyOf:
- *4
@@ -85289,7 +84870,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &625
+ deployment_branch_policy: &622
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -85405,9 +84986,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment
parameters:
- - *462
- - *463
- - &623
+ - *459
+ - *460
+ - &620
name: environment_name
in: path
required: true
@@ -85420,9 +85001,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: &626
+ default: &623
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -85506,9 +85087,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
requestBody:
required: false
content:
@@ -85517,7 +85098,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *624
+ wait_timer: *621
prevent_self_review:
type: boolean
example: false
@@ -85534,13 +85115,13 @@ paths:
items:
type: object
properties:
- type: *621
+ type: *618
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *625
+ deployment_branch_policy: *622
additionalProperties: false
examples:
default:
@@ -85560,9 +85141,9 @@ paths:
description: Response
content:
application/json:
- schema: *622
+ schema: *619
examples:
- default: *626
+ default: *623
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -85586,9 +85167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
responses:
'204':
description: Default response
@@ -85613,9 +85194,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *17
- *19
responses:
@@ -85633,7 +85214,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &627
+ items: &624
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -85690,9 +85271,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
requestBody:
required: true
content:
@@ -85738,9 +85319,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- example-wildcard: &628
+ example-wildcard: &625
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -85782,10 +85363,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
- - &629
+ - *459
+ - *460
+ - *620
+ - &626
name: branch_policy_id
in: path
required: true
@@ -85797,9 +85378,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *628
+ default: *625
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85818,10 +85399,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
- - *629
+ - *459
+ - *460
+ - *620
+ - *626
requestBody:
required: true
content:
@@ -85849,9 +85430,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *628
+ default: *625
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85870,10 +85451,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *462
- - *463
- - *623
- - *629
+ - *459
+ - *460
+ - *620
+ - *626
responses:
'204':
description: Response
@@ -85898,9 +85479,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *623
- - *463
- - *462
+ - *620
+ - *460
+ - *459
responses:
'200':
description: List of deployment protection rules
@@ -85916,7 +85497,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &630
+ items: &627
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -85935,7 +85516,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &631
+ app: &628
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -86034,9 +85615,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *623
- - *463
- - *462
+ - *620
+ - *460
+ - *459
requestBody:
content:
application/json:
@@ -86057,9 +85638,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *630
+ schema: *627
examples:
- default: &632
+ default: &629
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -86094,9 +85675,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *623
- - *463
- - *462
+ - *620
+ - *460
+ - *459
- *19
- *17
responses:
@@ -86115,7 +85696,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *631
+ items: *628
examples:
default:
value:
@@ -86150,10 +85731,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *462
- - *463
- - *623
- - &633
+ - *459
+ - *460
+ - *620
+ - &630
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -86165,9 +85746,9 @@ paths:
description: Response
content:
application/json:
- schema: *630
+ schema: *627
examples:
- default: *632
+ default: *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86188,10 +85769,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *623
- - *463
- - *462
- - *633
+ - *620
+ - *460
+ - *459
+ - *630
responses:
'204':
description: Response
@@ -86217,9 +85798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *17
- *19
responses:
@@ -86237,9 +85818,9 @@ paths:
type: integer
secrets:
type: array
- items: *493
+ items: *490
examples:
- default: *494
+ default: *491
headers:
Link: *47
x-github:
@@ -86264,17 +85845,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
responses:
'200':
description: Response
content:
application/json:
- schema: *495
+ schema: *492
examples:
- default: *496
+ default: *493
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86296,18 +85877,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *293
responses:
'200':
description: Response
content:
application/json:
- schema: *493
+ schema: *490
examples:
- default: *634
+ default: *631
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86329,9 +85910,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *293
requestBody:
required: true
@@ -86389,9 +85970,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *293
responses:
'204':
@@ -86417,10 +85998,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables
parameters:
- - *462
- - *463
- - *623
- - *480
+ - *459
+ - *460
+ - *620
+ - *477
- *19
responses:
'200':
@@ -86437,9 +86018,9 @@ paths:
type: integer
variables:
type: array
- items: *497
+ items: *494
examples:
- default: *498
+ default: *495
headers:
Link: *47
x-github:
@@ -86462,9 +86043,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
requestBody:
required: true
content:
@@ -86516,18 +86097,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable
parameters:
- - *462
- - *463
- - *623
+ - *459
+ - *460
+ - *620
- *296
responses:
'200':
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *635
+ default: *632
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86548,10 +86129,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
- - *623
+ - *620
requestBody:
required: true
content:
@@ -86593,10 +86174,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *296
- - *623
+ - *620
responses:
'204':
description: Response
@@ -86618,8 +86199,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -86687,8 +86268,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -86847,8 +86428,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -86880,9 +86461,9 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
'400': *14
'422': *15
'403': *29
@@ -86903,8 +86484,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -86964,7 +86545,7 @@ paths:
schema:
oneOf:
- *258
- - *636
+ - *633
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86989,8 +86570,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: file_sha
in: path
required: true
@@ -87089,8 +86670,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -87199,7 +86780,7 @@ paths:
description: Response
content:
application/json:
- schema: &637
+ schema: &634
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -87413,15 +86994,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object
parameters:
- - *462
- - *463
- - *580
+ - *459
+ - *460
+ - *577
responses:
'200':
description: Response
content:
application/json:
- schema: *637
+ schema: *634
examples:
default:
value:
@@ -87477,9 +87058,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references
parameters:
- - *462
- - *463
- - &638
+ - *459
+ - *460
+ - &635
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.
@@ -87496,7 +87077,7 @@ paths:
application/json:
schema:
type: array
- items: &639
+ items: &636
title: Git Reference
description: Git references within a repository
type: object
@@ -87571,17 +87152,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference
parameters:
- - *462
- - *463
- - *638
+ - *459
+ - *460
+ - *635
responses:
'200':
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: &640
+ default: &637
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -87610,8 +87191,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -87640,9 +87221,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: *640
+ default: *637
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -87668,9 +87249,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference
parameters:
- - *462
- - *463
- - *638
+ - *459
+ - *460
+ - *635
requestBody:
required: true
content:
@@ -87699,9 +87280,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: *640
+ default: *637
'422': *15
'409': *118
x-github:
@@ -87719,9 +87300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference
parameters:
- - *462
- - *463
- - *638
+ - *459
+ - *460
+ - *635
responses:
'204':
description: Response
@@ -87776,8 +87357,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -87844,7 +87425,7 @@ paths:
description: Response
content:
application/json:
- schema: &642
+ schema: &639
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -87895,7 +87476,7 @@ paths:
- sha
- type
- url
- verification: *641
+ verification: *638
required:
- sha
- url
@@ -87905,7 +87486,7 @@ paths:
- tag
- message
examples:
- default: &643
+ default: &640
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -87978,8 +87559,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tag_sha
in: path
required: true
@@ -87990,9 +87571,9 @@ paths:
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: *643
+ default: *640
'404': *6
'409': *118
x-github:
@@ -88016,8 +87597,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -88090,7 +87671,7 @@ paths:
description: Response
content:
application/json:
- schema: &644
+ schema: &641
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -88186,8 +87767,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -88210,7 +87791,7 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
default-response:
summary: Default response
@@ -88269,8 +87850,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -88280,7 +87861,7 @@ paths:
application/json:
schema:
type: array
- items: &645
+ items: &642
title: Webhook
description: Webhooks for repositories.
type: object
@@ -88334,7 +87915,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &906
+ last_response: &901
title: Hook Response
type: object
properties:
@@ -88408,8 +87989,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -88461,9 +88042,9 @@ paths:
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
- default: &646
+ default: &643
value:
type: Repository
id: 12345678
@@ -88511,17 +88092,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'200':
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
- default: *646
+ default: *643
'404': *6
x-github:
githubCloudOnly: false
@@ -88541,8 +88122,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
requestBody:
required: true
@@ -88588,9 +88169,9 @@ paths:
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
- default: *646
+ default: *643
'422': *15
'404': *6
x-github:
@@ -88611,8 +88192,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'204':
@@ -88637,8 +88218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'200':
@@ -88666,8 +88247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
requestBody:
required: false
@@ -88712,8 +88293,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
- *17
- *349
@@ -88745,8 +88326,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
- *16
responses:
@@ -88775,8 +88356,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
- *16
responses:
@@ -88800,8 +88381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'204':
@@ -88827,8 +88408,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *348
responses:
'204':
@@ -88852,8 +88433,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response if immutable releases are enabled
@@ -88899,8 +88480,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'409': *118
@@ -88920,8 +88501,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'409': *118
@@ -88978,14 +88559,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &647
+ schema: &644
title: Import
description: A repository import from an external source.
type: object
@@ -89084,7 +88665,7 @@ paths:
- html_url
- authors_url
examples:
- default: &650
+ default: &647
value:
vcs: subversion
use_lfs: true
@@ -89100,7 +88681,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': &648
+ '503': &645
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -89129,8 +88710,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -89178,7 +88759,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
default:
value:
@@ -89203,7 +88784,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89231,8 +88812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -89281,7 +88862,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
example-1:
summary: Example 1
@@ -89329,7 +88910,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': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89352,12 +88933,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89383,9 +88964,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors
parameters:
- - *462
- - *463
- - &836
+ - *459
+ - *460
+ - &831
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -89399,7 +88980,7 @@ paths:
application/json:
schema:
type: array
- items: &649
+ items: &646
title: Porter Author
description: Porter Author
type: object
@@ -89453,7 +89034,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': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89478,8 +89059,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: author_id
in: path
required: true
@@ -89509,7 +89090,7 @@ paths:
description: Response
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
value:
@@ -89522,7 +89103,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89546,8 +89127,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -89588,7 +89169,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89616,8 +89197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -89644,11 +89225,11 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
- default: *650
+ default: *647
'422': *15
- '503': *648
+ '503': *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89671,8 +89252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -89680,8 +89261,8 @@ paths:
application/json:
schema: *22
examples:
- default: *651
- '301': *468
+ default: *648
+ '301': *465
'404': *6
x-github:
githubCloudOnly: false
@@ -89701,8 +89282,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -89715,7 +89296,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &653
+ default: &650
value:
limit: collaborators_only
origin: repository
@@ -89740,13 +89321,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
application/json:
- schema: *652
+ schema: *649
examples:
default:
summary: Example request body
@@ -89760,7 +89341,7 @@ paths:
application/json:
schema: *366
examples:
- default: *653
+ default: *650
'409':
description: Response
x-github:
@@ -89782,8 +89363,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -89806,8 +89387,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -89817,9 +89398,9 @@ paths:
application/json:
schema:
type: array
- items: *654
+ items: *651
examples:
- default: &829
+ default: &824
value:
- id: 1
repository:
@@ -89950,8 +89531,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *370
requestBody:
required: false
@@ -89981,7 +89562,7 @@ paths:
description: Response
content:
application/json:
- schema: *654
+ schema: *651
examples:
default:
value:
@@ -90112,8 +89693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *370
responses:
'204':
@@ -90145,8 +89726,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues
parameters:
- - *462
- - *463
+ - *459
+ - *460
- 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
@@ -90219,7 +89800,7 @@ paths:
type: array
items: *220
examples:
- default: &666
+ default: &663
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -90367,7 +89948,7 @@ paths:
state_reason: completed
headers:
Link: *47
- '301': *468
+ '301': *465
'422': *15
'404': *6
x-github:
@@ -90396,8 +89977,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -90481,7 +90062,7 @@ paths:
application/json:
schema: *220
examples:
- default: &663
+ default: &660
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -90637,7 +90218,7 @@ paths:
'422': *15
'503': *195
'404': *6
- '410': *655
+ '410': *652
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -90665,8 +90246,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *244
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -90687,9 +90268,9 @@ paths:
application/json:
schema:
type: array
- items: *656
+ items: *653
examples:
- default: &665
+ default: &662
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90747,17 +90328,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'200':
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: &657
+ default: &654
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90811,8 +90392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -90835,9 +90416,9 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: *657
+ default: *654
'422': *15
x-github:
githubCloudOnly: false
@@ -90855,8 +90436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'204':
@@ -90877,8 +90458,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -90905,9 +90486,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
@@ -90928,8 +90509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -90962,16 +90543,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -90993,10 +90574,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- - *659
+ - *656
responses:
'204':
description: Response
@@ -91016,8 +90597,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -91027,7 +90608,7 @@ paths:
application/json:
schema:
type: array
- items: &662
+ items: &659
title: Issue Event
description: Issue Event
type: object
@@ -91070,8 +90651,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *660
- required: *661
+ properties: *657
+ required: *658
nullable: true
label:
title: Issue Event Label
@@ -91378,8 +90959,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: event_id
in: path
required: true
@@ -91390,7 +90971,7 @@ paths:
description: Response
content:
application/json:
- schema: *662
+ schema: *659
examples:
default:
value:
@@ -91582,7 +91163,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *655
+ '410': *652
'403': *29
x-github:
githubCloudOnly: false
@@ -91616,9 +91197,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue
parameters:
- - *462
- - *463
- - &664
+ - *459
+ - *460
+ - &661
name: issue_number
description: The number that identifies the issue.
in: path
@@ -91632,10 +91213,10 @@ paths:
application/json:
schema: *220
examples:
- default: *663
- '301': *468
+ default: *660
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
'304': *37
x-github:
githubCloudOnly: false
@@ -91660,9 +91241,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -91768,13 +91349,13 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
'422': *15
'503': *195
'403': *29
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91792,9 +91373,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -91822,7 +91403,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91838,9 +91419,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
content:
application/json:
@@ -91867,7 +91448,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91889,9 +91470,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: assignee
in: path
required: true
@@ -91931,9 +91512,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *227
- *17
- *19
@@ -91944,13 +91525,13 @@ paths:
application/json:
schema:
type: array
- items: *656
+ items: *653
examples:
- default: *665
+ default: *662
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91979,9 +91560,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -92003,16 +91584,16 @@ paths:
description: Response
content:
application/json:
- schema: *656
+ schema: *653
examples:
- default: *657
+ default: *654
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *655
+ '410': *652
'422': *15
'404': *6
x-github:
@@ -92040,9 +91621,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -92054,12 +91635,12 @@ paths:
type: array
items: *220
examples:
- default: *666
+ default: *663
headers:
Link: *47
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92087,9 +91668,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -92113,15 +91694,15 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *468
+ '301': *465
'403': *29
- '410': *655
+ '410': *652
'422': *15
'404': *6
x-github:
@@ -92152,9 +91733,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -92168,13 +91749,13 @@ paths:
application/json:
schema: *220
examples:
- default: *663
- '301': *468
+ default: *660
+ '301': *465
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *655
+ '410': *652
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -92200,9 +91781,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -92214,12 +91795,12 @@ paths:
type: array
items: *220
examples:
- default: *666
+ default: *663
headers:
Link: *47
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92236,9 +91817,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -92252,7 +91833,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &668
+ - &665
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -92306,7 +91887,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &669
+ - &666
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -92442,7 +92023,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &670
+ - &667
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -92493,7 +92074,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &671
+ - &668
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -92544,7 +92125,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &672
+ - &669
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -92598,7 +92179,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &673
+ - &670
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -92645,7 +92226,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &674
+ - &671
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -92692,7 +92273,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &675
+ - &672
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -92752,7 +92333,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &676
+ - &673
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -92800,7 +92381,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &677
+ - &674
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -92866,7 +92447,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &678
+ - &675
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -92932,7 +92513,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &679
+ - &676
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -92998,7 +92579,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &680
+ - &677
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -93089,7 +92670,7 @@ paths:
color: red
headers:
Link: *47
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93106,9 +92687,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -93120,7 +92701,7 @@ paths:
type: array
items: *219
examples:
- default: &667
+ default: &664
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -93138,9 +92719,9 @@ paths:
default: false
headers:
Link: *47
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93157,9 +92738,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -93220,10 +92801,10 @@ paths:
type: array
items: *219
examples:
- default: *667
- '301': *468
+ default: *664
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
'422': *15
x-github:
githubCloudOnly: false
@@ -93240,9 +92821,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -93304,10 +92885,10 @@ paths:
type: array
items: *219
examples:
- default: *667
- '301': *468
+ default: *664
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
'422': *15
x-github:
githubCloudOnly: false
@@ -93324,15 +92905,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
responses:
'204':
description: Response
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93351,9 +92932,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: name
in: path
required: true
@@ -93377,9 +92958,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *468
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93399,9 +92980,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: false
content:
@@ -93429,7 +93010,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *655
+ '410': *652
'404': *6
'422': *15
x-github:
@@ -93447,9 +93028,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
responses:
'204':
description: Response
@@ -93479,9 +93060,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
responses:
'200':
description: Response
@@ -93489,10 +93070,10 @@ paths:
application/json:
schema: *220
examples:
- default: *663
- '301': *468
+ default: *660
+ '301': *465
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93509,9 +93090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -93537,13 +93118,13 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93561,9 +93142,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93595,16 +93176,16 @@ paths:
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Response
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -93626,10 +93207,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *462
- - *463
- - *664
- - *659
+ - *459
+ - *460
+ - *661
+ - *656
responses:
'204':
description: Response
@@ -93658,9 +93239,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93684,7 +93265,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -93717,9 +93298,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -93731,11 +93312,11 @@ paths:
type: array
items: *220
examples:
- default: *666
+ default: *663
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93763,9 +93344,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93794,14 +93375,14 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *655
+ '410': *652
'422': *15
'404': *6
x-github:
@@ -93821,9 +93402,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
requestBody:
required: true
content:
@@ -93856,7 +93437,7 @@ paths:
application/json:
schema: *220
examples:
- default: *663
+ default: *660
'403': *29
'404': *6
'422': *7
@@ -93878,9 +93459,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *462
- - *463
- - *664
+ - *459
+ - *460
+ - *661
- *17
- *19
responses:
@@ -93895,6 +93476,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *665
+ - *666
+ - *667
- *668
- *669
- *670
@@ -93905,9 +93489,6 @@ paths:
- *675
- *676
- *677
- - *678
- - *679
- - *680
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -94216,7 +93797,7 @@ paths:
type: string
comments:
type: array
- items: &702
+ items: &699
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -94425,7 +94006,7 @@ paths:
type: string
comments:
type: array
- items: *576
+ items: *573
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -94714,7 +94295,7 @@ paths:
headers:
Link: *47
'404': *6
- '410': *655
+ '410': *652
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94731,8 +94312,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -94742,7 +94323,7 @@ paths:
application/json:
schema:
type: array
- items: &681
+ items: &678
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -94808,8 +94389,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -94845,9 +94426,9 @@ paths:
description: Response
content:
application/json:
- schema: *681
+ schema: *678
examples:
- default: &682
+ default: &679
value:
id: 1
key: ssh-rsa AAA...
@@ -94881,9 +94462,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *462
- - *463
- - &683
+ - *459
+ - *460
+ - &680
name: key_id
description: The unique identifier of the key.
in: path
@@ -94895,9 +94476,9 @@ paths:
description: Response
content:
application/json:
- schema: *681
+ schema: *678
examples:
- default: *682
+ default: *679
'404': *6
x-github:
githubCloudOnly: false
@@ -94915,9 +94496,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *462
- - *463
- - *683
+ - *459
+ - *460
+ - *680
responses:
'204':
description: Response
@@ -94937,8 +94518,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -94950,7 +94531,7 @@ paths:
type: array
items: *219
examples:
- default: *667
+ default: *664
headers:
Link: *47
'404': *6
@@ -94971,8 +94552,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95010,7 +94591,7 @@ paths:
application/json:
schema: *219
examples:
- default: &684
+ default: &681
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -95042,8 +94623,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: name
in: path
required: true
@@ -95056,7 +94637,7 @@ paths:
application/json:
schema: *219
examples:
- default: *684
+ default: *681
'404': *6
x-github:
githubCloudOnly: false
@@ -95073,8 +94654,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: name
in: path
required: true
@@ -95139,8 +94720,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: name
in: path
required: true
@@ -95166,8 +94747,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -95203,8 +94784,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'202': *39
'403':
@@ -95232,8 +94813,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -95259,9 +94840,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *462
- - *463
- - *549
+ - *459
+ - *460
+ - *546
responses:
'200':
description: Response
@@ -95406,8 +94987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95472,8 +95053,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95507,9 +95088,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *685
+ default: *682
'204':
description: Response when already merged
'404':
@@ -95534,8 +95115,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -95576,7 +95157,7 @@ paths:
application/json:
schema:
type: array
- items: &686
+ items: &683
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -95637,8 +95218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -95678,9 +95259,9 @@ paths:
description: Response
content:
application/json:
- schema: *686
+ schema: *683
examples:
- default: &687
+ default: &684
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -95739,9 +95320,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone
parameters:
- - *462
- - *463
- - &688
+ - *459
+ - *460
+ - &685
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -95753,9 +95334,9 @@ paths:
description: Response
content:
application/json:
- schema: *686
+ schema: *683
examples:
- default: *687
+ default: *684
'404': *6
x-github:
githubCloudOnly: false
@@ -95772,9 +95353,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone
parameters:
- - *462
- - *463
- - *688
+ - *459
+ - *460
+ - *685
requestBody:
required: false
content:
@@ -95812,9 +95393,9 @@ paths:
description: Response
content:
application/json:
- schema: *686
+ schema: *683
examples:
- default: *687
+ default: *684
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95830,9 +95411,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone
parameters:
- - *462
- - *463
- - *688
+ - *459
+ - *460
+ - *685
responses:
'204':
description: Response
@@ -95853,9 +95434,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *462
- - *463
- - *688
+ - *459
+ - *460
+ - *685
- *17
- *19
responses:
@@ -95867,7 +95448,7 @@ paths:
type: array
items: *219
examples:
- default: *667
+ default: *664
headers:
Link: *47
x-github:
@@ -95886,12 +95467,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *462
- - *463
- - *689
- - *690
+ - *459
+ - *460
+ - *686
+ - *687
- *227
- - *691
+ - *688
- *17
- *19
responses:
@@ -95903,7 +95484,7 @@ paths:
type: array
items: *247
examples:
- default: *692
+ default: *689
headers:
Link: *47
x-github:
@@ -95927,8 +95508,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -95986,14 +95567,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: &693
+ schema: &690
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -96118,7 +95699,7 @@ paths:
- custom_404
- public
examples:
- default: &694
+ default: &691
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -96159,8 +95740,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -96214,9 +95795,9 @@ paths:
description: Response
content:
application/json:
- schema: *693
+ schema: *690
examples:
- default: *694
+ default: *691
'422': *15
'409': *118
x-github:
@@ -96239,8 +95820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -96347,8 +95928,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -96374,8 +95955,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -96385,7 +95966,7 @@ paths:
application/json:
schema:
type: array
- items: &695
+ items: &692
title: Page Build
description: Page Build
type: object
@@ -96479,8 +96060,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'201':
description: Response
@@ -96525,16 +96106,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *695
+ schema: *692
examples:
- default: &696
+ default: &693
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -96582,8 +96163,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: build_id
in: path
required: true
@@ -96594,9 +96175,9 @@ paths:
description: Response
content:
application/json:
- schema: *695
+ schema: *692
examples:
- default: *696
+ default: *693
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96616,8 +96197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -96722,9 +96303,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *462
- - *463
- - &697
+ - *459
+ - *460
+ - &694
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -96782,9 +96363,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *462
- - *463
- - *697
+ - *459
+ - *460
+ - *694
responses:
'204': *154
'404': *6
@@ -96811,8 +96392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -97070,8 +96651,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Private vulnerability reporting status
@@ -97108,8 +96689,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'422': *14
@@ -97130,8 +96711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204': *154
'422': *14
@@ -97153,8 +96734,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -97164,7 +96745,7 @@ paths:
type: array
items: *155
examples:
- default: *698
+ default: *695
'403': *29
'404': *6
x-github:
@@ -97186,8 +96767,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -97203,7 +96784,7 @@ paths:
required:
- properties
examples:
- default: *699
+ default: *696
responses:
'204':
description: No Content when custom property values are successfully created
@@ -97241,8 +96822,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -97302,9 +96883,9 @@ paths:
application/json:
schema:
type: array
- items: *583
+ items: *580
examples:
- default: *700
+ default: *697
headers:
Link: *47
'304': *37
@@ -97336,8 +96917,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -97402,7 +96983,7 @@ paths:
description: Response
content:
application/json:
- schema: &704
+ schema: &701
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -97616,7 +97197,7 @@ paths:
- review_comment
- self
author_association: *221
- auto_merge: *701
+ auto_merge: *698
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -97708,7 +97289,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &705
+ default: &702
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -98235,8 +97816,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sort
in: query
required: false
@@ -98265,9 +97846,9 @@ paths:
application/json:
schema:
type: array
- items: *702
+ items: *699
examples:
- default: &707
+ default: &704
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -98344,17 +97925,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'200':
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
- default: &703
+ default: &700
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -98429,8 +98010,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -98453,9 +98034,9 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
- default: *703
+ default: *700
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98471,8 +98052,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
responses:
'204':
@@ -98494,8 +98075,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -98522,9 +98103,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
@@ -98545,8 +98126,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
requestBody:
required: true
@@ -98579,16 +98160,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -98610,10 +98191,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *236
- - *659
+ - *656
responses:
'204':
description: Response
@@ -98656,9 +98237,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request
parameters:
- - *462
- - *463
- - &706
+ - *459
+ - *460
+ - &703
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -98671,9 +98252,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *704
+ schema: *701
examples:
- default: *705
+ default: *702
'304': *37
'404': *6
'406':
@@ -98708,9 +98289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -98752,9 +98333,9 @@ paths:
description: Response
content:
application/json:
- schema: *704
+ schema: *701
examples:
- default: *705
+ default: *702
'422': *15
'403': *29
x-github:
@@ -98776,9 +98357,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: true
content:
@@ -98840,7 +98421,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -98848,7 +98429,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'401': *25
'403': *29
'404': *6
@@ -98878,9 +98459,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *244
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -98901,9 +98482,9 @@ paths:
application/json:
schema:
type: array
- items: *702
+ items: *699
examples:
- default: *707
+ default: *704
headers:
Link: *47
x-github:
@@ -98936,9 +98517,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: true
content:
@@ -99043,7 +98624,7 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
example-for-a-multi-line-comment:
value:
@@ -99131,9 +98712,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *236
requestBody:
required: true
@@ -99156,7 +98737,7 @@ paths:
description: Response
content:
application/json:
- schema: *702
+ schema: *699
examples:
default:
value:
@@ -99242,9 +98823,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *17
- *19
responses:
@@ -99254,9 +98835,9 @@ paths:
application/json:
schema:
type: array
- items: *579
+ items: *576
examples:
- default: *708
+ default: *705
headers:
Link: *47
x-github:
@@ -99286,9 +98867,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *17
- *19
responses:
@@ -99298,7 +98879,7 @@ paths:
application/json:
schema:
type: array
- items: *592
+ items: *589
examples:
default:
value:
@@ -99336,9 +98917,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
responses:
'204':
description: Response if pull request has been merged
@@ -99361,9 +98942,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -99474,9 +99055,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
responses:
'200':
description: Response
@@ -99551,9 +99132,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -99590,7 +99171,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
default:
value:
@@ -100126,9 +99707,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: true
content:
@@ -100162,7 +99743,7 @@ paths:
description: Response
content:
application/json:
- schema: *583
+ schema: *580
examples:
default:
value:
@@ -100667,9 +100248,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
- *17
- *19
responses:
@@ -100679,7 +100260,7 @@ paths:
application/json:
schema:
type: array
- items: &709
+ items: &706
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -100830,9 +100411,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -100918,9 +100499,9 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: &711
+ default: &708
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -100983,10 +100564,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - &710
+ - *459
+ - *460
+ - *703
+ - &707
name: review_id
description: The unique identifier of the review.
in: path
@@ -100998,9 +100579,9 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: &712
+ default: &709
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -101059,10 +100640,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
requestBody:
required: true
content:
@@ -101085,7 +100666,7 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
default:
value:
@@ -101147,18 +100728,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
responses:
'200':
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: *711
+ default: *708
'422': *7
'404': *6
x-github:
@@ -101185,10 +100766,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
- *17
- *19
responses:
@@ -101423,10 +101004,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
requestBody:
required: true
content:
@@ -101454,7 +101035,7 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
default:
value:
@@ -101517,10 +101098,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *462
- - *463
- - *706
- - *710
+ - *459
+ - *460
+ - *703
+ - *707
requestBody:
required: true
content:
@@ -101555,9 +101136,9 @@ paths:
description: Response
content:
application/json:
- schema: *709
+ schema: *706
examples:
- default: *712
+ default: *709
'404': *6
'422': *7
'403': *29
@@ -101579,9 +101160,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *462
- - *463
- - *706
+ - *459
+ - *460
+ - *703
requestBody:
required: false
content:
@@ -101644,8 +101225,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -101658,9 +101239,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: &714
+ default: &711
value:
type: file
encoding: base64
@@ -101702,8 +101283,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: dir
description: The alternate path to look for a README file
in: path
@@ -101723,9 +101304,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: *714
+ default: *711
'404': *6
'422': *15
x-github:
@@ -101747,8 +101328,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -101758,7 +101339,7 @@ paths:
application/json:
schema:
type: array
- items: *715
+ items: *712
examples:
default:
value:
@@ -101852,8 +101433,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -101929,9 +101510,9 @@ paths:
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: &719
+ default: &716
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -102036,9 +101617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset
parameters:
- - *462
- - *463
- - &717
+ - *459
+ - *460
+ - &714
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -102050,9 +101631,9 @@ paths:
description: Response
content:
application/json:
- schema: *716
+ schema: *713
examples:
- default: &718
+ default: &715
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
@@ -102087,7 +101668,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *594
+ '302': *591
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -102103,9 +101684,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset
parameters:
- - *462
- - *463
- - *717
+ - *459
+ - *460
+ - *714
requestBody:
required: false
content:
@@ -102133,9 +101714,9 @@ paths:
description: Response
content:
application/json:
- schema: *716
+ schema: *713
examples:
- default: *718
+ default: *715
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -102151,9 +101732,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset
parameters:
- - *462
- - *463
- - *717
+ - *459
+ - *460
+ - *714
responses:
'204':
description: Response
@@ -102177,8 +101758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -102263,16 +101844,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -102289,8 +101870,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tag
description: tag parameter
in: path
@@ -102303,9 +101884,9 @@ paths:
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
'404': *6
x-github:
githubCloudOnly: false
@@ -102327,9 +101908,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release
parameters:
- - *462
- - *463
- - &720
+ - *459
+ - *460
+ - &717
name: release_id
description: The unique identifier of the release.
in: path
@@ -102343,9 +101924,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
'401':
description: Unauthorized
x-github:
@@ -102363,9 +101944,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
requestBody:
required: false
content:
@@ -102429,9 +102010,9 @@ paths:
description: Response
content:
application/json:
- schema: *715
+ schema: *712
examples:
- default: *719
+ default: *716
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -102452,9 +102033,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
responses:
'204':
description: Response
@@ -102474,9 +102055,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
- *17
- *19
responses:
@@ -102486,7 +102067,7 @@ paths:
application/json:
schema:
type: array
- items: *716
+ items: *713
examples:
default:
value:
@@ -102568,9 +102149,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:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
- name: name
in: query
required: true
@@ -102596,7 +102177,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *716
+ schema: *713
examples:
response-for-successful-upload:
value:
@@ -102651,9 +102232,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -102677,9 +102258,9 @@ paths:
application/json:
schema:
type: array
- items: *577
+ items: *574
examples:
- default: *658
+ default: *655
headers:
Link: *47
'404': *6
@@ -102700,9 +102281,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *462
- - *463
- - *720
+ - *459
+ - *460
+ - *717
requestBody:
required: true
content:
@@ -102732,16 +102313,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'201':
description: Reaction created
content:
application/json:
- schema: *577
+ schema: *574
examples:
- default: *578
+ default: *575
'422': *15
x-github:
githubCloudOnly: false
@@ -102763,10 +102344,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *462
- - *463
- - *720
- - *659
+ - *459
+ - *460
+ - *717
+ - *656
responses:
'204':
description: Response
@@ -102790,9 +102371,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch
parameters:
- - *462
- - *463
- - *515
+ - *459
+ - *460
+ - *512
- *17
- *19
responses:
@@ -102809,7 +102390,7 @@ paths:
oneOf:
- allOf:
- *169
- - &721
+ - &718
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -102830,67 +102411,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *170
- - *721
+ - *718
- allOf:
- *171
- - *721
+ - *718
- allOf:
- *172
- - *721
+ - *718
- allOf:
- - *722
- - *721
+ - *719
+ - *718
- allOf:
- *173
- - *721
+ - *718
- allOf:
- *174
- - *721
+ - *718
- allOf:
- *175
- - *721
+ - *718
- allOf:
- *176
- - *721
+ - *718
- allOf:
- *177
- - *721
+ - *718
- allOf:
- *178
- - *721
+ - *718
- allOf:
- *179
- - *721
+ - *718
- allOf:
- *180
- - *721
+ - *718
- allOf:
- *181
- - *721
+ - *718
- allOf:
- *182
- - *721
+ - *718
- allOf:
- *183
- - *721
+ - *718
- allOf:
- *184
- - *721
+ - *718
- allOf:
- *185
- - *721
+ - *718
- allOf:
- *186
- - *721
+ - *718
- allOf:
- *187
- - *721
+ - *718
- allOf:
- *188
- - *721
+ - *718
- allOf:
- *189
- - *721
+ - *718
examples:
default:
value:
@@ -102929,8 +102510,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- name: includes_parents
@@ -102941,7 +102522,7 @@ paths:
schema:
type: boolean
default: true
- - *723
+ - *720
responses:
'200':
description: Response
@@ -102996,8 +102577,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
description: Request body
required: true
@@ -103026,7 +102607,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *724
+ items: *721
required:
- name
- enforcement
@@ -103059,7 +102640,7 @@ paths:
application/json:
schema: *190
examples:
- default: &733
+ default: &730
value:
id: 42
name: super cool ruleset
@@ -103106,12 +102687,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *462
- - *463
- - *725
+ - *459
+ - *460
+ - *722
- *105
- - *726
- - *727
+ - *723
+ - *724
- *17
- *19
responses:
@@ -103119,9 +102700,9 @@ paths:
description: Response
content:
application/json:
- schema: *728
+ schema: *725
examples:
- default: *729
+ default: *726
'404': *6
'500': *40
x-github:
@@ -103142,17 +102723,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *462
- - *463
- - *730
+ - *459
+ - *460
+ - *727
responses:
'200':
description: Response
content:
application/json:
- schema: *731
+ schema: *728
examples:
- default: *732
+ default: *729
'404': *6
'500': *40
x-github:
@@ -103180,8 +102761,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103203,7 +102784,7 @@ paths:
application/json:
schema: *190
examples:
- default: *733
+ default: *730
'404': *6
'500': *40
put:
@@ -103221,8 +102802,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103256,7 +102837,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *724
+ items: *721
examples:
default:
value:
@@ -103286,7 +102867,7 @@ paths:
application/json:
schema: *190
examples:
- default: *733
+ default: *730
'404': *6
'500': *40
delete:
@@ -103304,8 +102885,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103328,8 +102909,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
- name: ruleset_id
@@ -103366,8 +102947,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103440,8 +103021,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *427
- *428
- *429
@@ -103450,8 +103031,8 @@ paths:
- *110
- *19
- *17
- - *734
- - *735
+ - *731
+ - *732
- *432
- *433
- *434
@@ -103463,7 +103044,7 @@ paths:
application/json:
schema:
type: array
- items: &739
+ items: &736
type: object
properties:
number: *127
@@ -103482,8 +103063,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *736
- resolution: *737
+ state: *733
+ resolution: *734
resolved_at:
type: string
format: date-time
@@ -103579,7 +103160,7 @@ paths:
pull request.
'
- oneOf: *738
+ oneOf: *735
nullable: true
has_more_locations:
type: boolean
@@ -103728,16 +103309,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
- *435
responses:
'200':
description: Response
content:
application/json:
- schema: *739
+ schema: *736
examples:
default:
value:
@@ -103791,9 +103372,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
requestBody:
required: true
content:
@@ -103801,8 +103382,8 @@ paths:
schema:
type: object
properties:
- state: *736
- resolution: *737
+ state: *733
+ resolution: *734
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -103836,7 +103417,7 @@ paths:
description: Response
content:
application/json:
- schema: *739
+ schema: *736
examples:
default:
value:
@@ -103931,9 +103512,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *462
- - *463
- - *543
+ - *459
+ - *460
+ - *540
- *19
- *17
responses:
@@ -103944,7 +103525,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &928
+ items: &923
type: object
properties:
type:
@@ -103970,6 +103551,9 @@ paths:
example: commit
details:
oneOf:
+ - *737
+ - *738
+ - *739
- *740
- *741
- *742
@@ -103980,9 +103564,6 @@ paths:
- *747
- *748
- *749
- - *750
- - *751
- - *752
examples:
default:
value:
@@ -104068,8 +103649,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -104077,14 +103658,14 @@ paths:
schema:
type: object
properties:
- reason: &754
+ reason: &751
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *753
+ placeholder_id: *750
required:
- reason
- placeholder_id
@@ -104101,7 +103682,7 @@ paths:
schema:
type: object
properties:
- reason: *754
+ reason: *751
expire_at:
type: string
format: date-time
@@ -104147,8 +103728,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -104163,7 +103744,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &755
+ items: &752
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -104189,15 +103770,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *755
+ items: *752
backfill_scans:
type: array
- items: *755
+ items: *752
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *755
+ - *752
- type: object
properties:
pattern_name:
@@ -104267,8 +103848,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *110
- name: sort
description: The property to sort the results by.
@@ -104312,9 +103893,9 @@ paths:
application/json:
schema:
type: array
- items: *756
+ items: *753
examples:
- default: *757
+ default: *754
'400': *14
'404': *6
x-github:
@@ -104337,8 +103918,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -104498,9 +104079,9 @@ paths:
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
- default: &759
+ default: &756
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -104733,8 +104314,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -104838,7 +104419,7 @@ paths:
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
default:
value:
@@ -104985,17 +104566,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
responses:
'200':
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
- default: *759
+ default: *756
'403': *29
'404': *6
x-github:
@@ -105019,9 +104600,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
requestBody:
required: true
content:
@@ -105180,10 +104761,10 @@ paths:
description: Response
content:
application/json:
- schema: *756
+ schema: *753
examples:
- default: *759
- add_credit: *759
+ default: *756
+ add_credit: *756
'403': *29
'404': *6
'422':
@@ -105221,9 +104802,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
responses:
'202': *39
'400': *14
@@ -105250,17 +104831,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *462
- - *463
- - *758
+ - *459
+ - *460
+ - *755
responses:
'202':
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
'400': *14
'422': *15
'403': *29
@@ -105286,8 +104867,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -105386,8 +104967,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -105396,7 +104977,7 @@ paths:
application/json:
schema:
type: array
- items: &760
+ items: &757
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -105429,8 +105010,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -105506,8 +105087,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -105603,8 +105184,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -105758,8 +105339,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -105769,7 +105350,7 @@ paths:
application/json:
schema:
type: array
- items: *760
+ items: *757
examples:
default:
value:
@@ -105802,8 +105383,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: sha
in: path
required: true
@@ -105857,7 +105438,7 @@ paths:
description: Response
content:
application/json:
- schema: *761
+ schema: *758
examples:
default:
value:
@@ -105911,8 +105492,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -105944,14 +105525,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &762
+ schema: &759
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -106019,8 +105600,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -106046,7 +105627,7 @@ paths:
description: Response
content:
application/json:
- schema: *762
+ schema: *759
examples:
default:
value:
@@ -106073,8 +105654,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -106094,8 +105675,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -106174,8 +105755,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -106183,7 +105764,7 @@ paths:
application/json:
schema:
type: array
- items: &763
+ items: &760
title: Tag protection
description: Tag protection
type: object
@@ -106235,8 +105816,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -106259,7 +105840,7 @@ paths:
description: Response
content:
application/json:
- schema: *763
+ schema: *760
examples:
default:
value:
@@ -106290,8 +105871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -106328,8 +105909,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
in: path
required: true
@@ -106365,8 +105946,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *17
- *19
responses:
@@ -106398,8 +105979,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics
parameters:
- - *462
- - *463
+ - *459
+ - *460
- *19
- *17
responses:
@@ -106407,7 +105988,7 @@ paths:
description: Response
content:
application/json:
- schema: &764
+ schema: &761
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -106419,7 +106000,7 @@ paths:
required:
- names
examples:
- default: &765
+ default: &762
value:
names:
- octocat
@@ -106442,8 +106023,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -106474,9 +106055,9 @@ paths:
description: Response
content:
application/json:
- schema: *764
+ schema: *761
examples:
- default: *765
+ default: *762
'404': *6
'422': *7
x-github:
@@ -106497,9 +106078,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones
parameters:
- - *462
- - *463
- - &766
+ - *459
+ - *460
+ - &763
name: per
description: The time frame to display results for.
in: query
@@ -106528,7 +106109,7 @@ paths:
example: 128
clones:
type: array
- items: &767
+ items: &764
title: Traffic
type: object
properties:
@@ -106616,8 +106197,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -106708,8 +106289,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'200':
description: Response
@@ -106770,9 +106351,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views
parameters:
- - *462
- - *463
- - *766
+ - *459
+ - *460
+ - *763
responses:
'200':
description: Response
@@ -106791,7 +106372,7 @@ paths:
example: 3782
views:
type: array
- items: *767
+ items: *764
required:
- uniques
- count
@@ -106869,8 +106450,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
requestBody:
required: true
content:
@@ -107144,8 +106725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -107168,8 +106749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -107191,8 +106772,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -107218,8 +106799,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *462
- - *463
+ - *459
+ - *460
- name: ref
in: path
required: true
@@ -107311,9 +106892,9 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -107464,7 +107045,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &775
+ - &772
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -107473,7 +107054,7 @@ paths:
schema:
type: string
example: members
- - &780
+ - &777
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -107484,7 +107065,7 @@ paths:
default: 1
format: int32
example: 1
- - &781
+ - &778
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -107526,7 +107107,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &770
+ items: &767
allOf:
- type: object
required:
@@ -107601,7 +107182,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &782
+ meta: &779
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -107661,30 +107242,30 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &771
+ '400': &768
description: Bad request
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '401': *769
- '403': &772
+ schema: *765
+ '401': *766
+ '403': &769
description: Permission denied
- '429': &773
+ '429': &770
description: Too many requests
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '500': &774
+ schema: *765
+ '500': &771
description: Internal server error
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
+ schema: *765
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107708,7 +107289,7 @@ paths:
required: true
content:
application/json:
- schema: &778
+ schema: &775
type: object
required:
- schemas
@@ -107768,9 +107349,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- group: &776
+ group: &773
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -107789,13 +107370,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *771
- '401': *769
- '403': *772
- '409': &779
+ '400': *768
+ '401': *766
+ '403': *769
+ '409': &776
description: Duplicate record detected
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107812,7 +107393,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &777
+ - &774
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -107820,22 +107401,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *775
+ - *772
- *41
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- default: *776
- '400': *771
- '401': *769
- '403': *772
+ default: *773
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107854,13 +107435,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *777
+ - *774
- *41
requestBody:
required: true
content:
application/json:
- schema: *778
+ schema: *775
examples:
group:
summary: Group
@@ -107886,17 +107467,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- group: *776
- groupWithMembers: *776
- '400': *771
- '401': *769
- '403': *772
+ group: *773
+ groupWithMembers: *773
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107920,13 +107501,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *777
+ - *774
- *41
requestBody:
required: true
content:
application/json:
- schema: &789
+ schema: &786
type: object
required:
- Operations
@@ -107986,17 +107567,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *770
+ schema: *767
examples:
- updateGroup: *776
- addMembers: *776
- '400': *771
- '401': *769
- '403': *772
+ updateGroup: *773
+ addMembers: *773
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108012,17 +107593,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *777
+ - *774
- *41
responses:
'204':
description: Group was deleted, no content
- '400': *771
- '401': *769
- '403': *772
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108056,8 +107637,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *780
- - *781
+ - *777
+ - *778
- *41
responses:
'200':
@@ -108090,7 +107671,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &784
+ items: &781
allOf:
- type: object
required:
@@ -108169,7 +107750,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &783
+ roles: &780
type: array
description: The roles assigned to the user.
items:
@@ -108225,7 +107806,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *782
+ meta: *779
startIndex:
type: integer
description: A starting index for the returned page
@@ -108262,11 +107843,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *771
- '401': *769
- '403': *772
- '429': *773
- '500': *774
+ '400': *768
+ '401': *766
+ '403': *769
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108290,7 +107871,7 @@ paths:
required: true
content:
application/json:
- schema: &787
+ schema: &784
type: object
required:
- schemas
@@ -108372,9 +107953,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *783
+ roles: *780
examples:
- user: &788
+ user: &785
summary: User
value:
schemas:
@@ -108421,9 +108002,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- user: &785
+ user: &782
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -108449,13 +108030,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *785
- '400': *771
- '401': *769
- '403': *772
- '409': *779
- '429': *773
- '500': *774
+ enterpriseOwner: *782
+ '400': *768
+ '401': *766
+ '403': *769
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108472,7 +108053,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &786
+ - &783
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -108485,15 +108066,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- default: *785
- '400': *771
- '401': *769
- '403': *772
+ default: *782
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108515,30 +108096,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *786
+ - *783
- *41
requestBody:
required: true
content:
application/json:
- schema: *787
+ schema: *784
examples:
- user: *788
+ user: *785
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- user: *785
- '400': *771
- '401': *769
- '403': *772
+ user: *782
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108573,13 +108154,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *786
+ - *783
- *41
requestBody:
required: true
content:
application/json:
- schema: *789
+ schema: *786
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -108619,18 +108200,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *784
+ schema: *781
examples:
- userMultiValuedProperties: *785
- userSingleValuedProperties: *785
- disableUser: *785
- '400': *771
- '401': *769
- '403': *772
+ userMultiValuedProperties: *782
+ userSingleValuedProperties: *782
+ disableUser: *782
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '409': *779
- '429': *773
- '500': *774
+ '409': *776
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108650,17 +108231,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *786
+ - *783
- *41
responses:
'204':
description: User was deleted, no content
- '400': *771
- '401': *769
- '403': *772
+ '400': *768
+ '401': *766
+ '403': *769
'404': *6
- '429': *773
- '500': *774
+ '429': *770
+ '500': *771
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108747,7 +108328,7 @@ paths:
example: 1
Resources:
type: array
- items: &790
+ items: &787
title: SCIM /Users
description: SCIM /Users provisioning endpoints
type: object
@@ -108978,22 +108559,22 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243
'304': *37
- '404': &791
+ '404': &788
description: Resource not found
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '403': &792
+ schema: *765
+ '403': &789
description: Forbidden
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '400': *771
- '429': *773
+ schema: *765
+ '400': *768
+ '429': *770
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -109019,9 +108600,9 @@ paths:
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: &793
+ default: &790
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -109044,17 +108625,17 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32
'304': *37
- '404': *791
- '403': *792
- '500': *774
+ '404': *788
+ '403': *789
+ '500': *771
'409':
description: Conflict
content:
application/json:
- schema: *768
+ schema: *765
application/scim+json:
- schema: *768
- '400': *771
+ schema: *765
+ '400': *768
requestBody:
required: true
content:
@@ -109152,17 +108733,17 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user
parameters:
- *87
- - *786
+ - *783
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: *793
- '404': *791
- '403': *792
+ default: *790
+ '404': *788
+ '403': *789
'304': *37
x-github:
githubCloudOnly: true
@@ -109186,18 +108767,18 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership
parameters:
- *87
- - *786
+ - *783
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: *793
+ default: *790
'304': *37
- '404': *791
- '403': *792
+ '404': *788
+ '403': *789
requestBody:
required: true
content:
@@ -109310,19 +108891,19 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user
parameters:
- *87
- - *786
+ - *783
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *790
+ schema: *787
examples:
- default: *793
+ default: *790
'304': *37
- '404': *791
- '403': *792
- '400': *771
+ '404': *788
+ '403': *789
+ '400': *768
'429':
description: Response
content:
@@ -109413,12 +108994,12 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization
parameters:
- *87
- - *786
+ - *783
responses:
'204':
description: Response
- '404': *791
- '403': *792
+ '404': *788
+ '403': *789
'304': *37
x-github:
githubCloudOnly: true
@@ -109551,7 +109132,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &794
+ text_matches: &791
title: Search Result Text Matches
type: array
items:
@@ -109714,7 +109295,7 @@ paths:
enum:
- author-date
- committer-date
- - &795
+ - &792
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
@@ -109785,7 +109366,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *513
+ properties: *510
nullable: true
comment_count:
type: integer
@@ -109805,7 +109386,7 @@ paths:
url:
type: string
format: uri
- verification: *641
+ verification: *638
required:
- author
- committer
@@ -109824,7 +109405,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *513
+ properties: *510
nullable: true
parents:
type: array
@@ -109842,7 +109423,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *794
+ text_matches: *791
required:
- sha
- node_id
@@ -110035,7 +109616,7 @@ paths:
- interactions
- created
- updated
- - *795
+ - *792
- *17
- *19
- name: advanced_search
@@ -110132,11 +109713,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
type: string
state_reason:
@@ -110168,7 +109749,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *794
+ text_matches: *791
pull_request:
type: object
properties:
@@ -110393,7 +109974,7 @@ paths:
enum:
- created
- updated
- - *795
+ - *792
- *17
- *19
responses:
@@ -110437,7 +110018,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *794
+ text_matches: *791
required:
- id
- node_id
@@ -110523,7 +110104,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *795
+ - *792
- *17
- *19
responses:
@@ -110762,7 +110343,7 @@ paths:
- admin
- pull
- push
- text_matches: *794
+ text_matches: *791
temp_clone_token:
type: string
allow_merge_commit:
@@ -111063,7 +110644,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *794
+ text_matches: *791
related:
type: array
nullable: true
@@ -111256,7 +110837,7 @@ paths:
- followers
- repositories
- joined
- - *795
+ - *792
- *17
- *19
responses:
@@ -111360,7 +110941,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *794
+ text_matches: *791
blog:
type: string
nullable: true
@@ -111439,7 +111020,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy
parameters:
- - &799
+ - &796
name: team_id
description: The unique identifier of the team.
in: path
@@ -111480,7 +111061,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy
parameters:
- - *799
+ - *796
requestBody:
required: true
content:
@@ -111580,7 +111161,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy
parameters:
- - *799
+ - *796
responses:
'204':
description: Response
@@ -111611,7 +111192,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
parameters:
- - *799
+ - *796
- *110
- *17
- *19
@@ -111624,7 +111205,7 @@ paths:
type: array
items: *451
examples:
- default: *800
+ default: *797
headers:
Link: *47
x-github:
@@ -111653,7 +111234,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
parameters:
- - *799
+ - *796
requestBody:
required: true
content:
@@ -111716,7 +111297,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
parameters:
- - *799
+ - *796
- *453
responses:
'200':
@@ -111750,7 +111331,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy
parameters:
- - *799
+ - *796
- *453
requestBody:
required: false
@@ -111776,7 +111357,7 @@ paths:
application/json:
schema: *451
examples:
- default: *801
+ default: *798
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -111801,7 +111382,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
parameters:
- - *799
+ - *796
- *453
responses:
'204':
@@ -111814,218 +111395,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - *799
- - *453
- - *110
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *454
- examples:
- default: *802
- headers:
- Link: *47
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *455
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- - *456
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *455
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- - *456
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *454
- examples:
- default: *803
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - *799
- - *453
- - *456
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -112041,7 +111410,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *799
+ - *796
- *17
- *19
responses:
@@ -112079,7 +111448,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy
parameters:
- - *799
+ - *796
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -112130,7 +111499,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112167,7 +111536,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112207,7 +111576,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112244,16 +111613,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'200':
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- response-if-user-is-a-team-maintainer: *804
+ response-if-user-is-a-team-maintainer: *799
'404': *6
x-github:
githubCloudOnly: false
@@ -112286,7 +111655,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *799
+ - *796
- *142
requestBody:
required: false
@@ -112312,9 +111681,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- response-if-users-membership-with-team-is-now-pending: *805
+ response-if-users-membership-with-team-is-now-pending: *800
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -112348,7 +111717,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *799
+ - *796
- *142
responses:
'204':
@@ -112376,7 +111745,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy
parameters:
- - *799
+ - *796
- *17
- *19
responses:
@@ -112418,15 +111787,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *799
- - *462
- - *463
+ - *796
+ - *459
+ - *460
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *806
+ schema: *801
examples:
alternative-response-with-extra-repository-information:
value:
@@ -112577,9 +111946,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *799
- - *462
- - *463
+ - *796
+ - *459
+ - *460
requestBody:
required: false
content:
@@ -112629,9 +111998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *799
- - *462
- - *463
+ - *796
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -112660,15 +112029,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy
parameters:
- - *799
+ - *796
responses:
'200':
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *465
+ default: *462
'403': *29
'404': *6
x-github:
@@ -112695,7 +112064,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy
parameters:
- - *799
+ - *796
requestBody:
required: true
content:
@@ -112752,7 +112121,7 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default:
value:
@@ -112783,7 +112152,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy
parameters:
- - *799
+ - *796
- *17
- *19
responses:
@@ -112795,7 +112164,7 @@ paths:
type: array
items: *312
examples:
- response-if-child-teams-exist: *807
+ response-if-child-teams-exist: *802
headers:
Link: *47
'404': *6
@@ -112828,7 +112197,7 @@ paths:
application/json:
schema:
oneOf:
- - &809
+ - &804
title: Private User
description: Private User
type: object
@@ -113031,7 +112400,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *808
+ - *803
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -113184,7 +112553,7 @@ paths:
description: Response
content:
application/json:
- schema: *809
+ schema: *804
examples:
default:
value:
@@ -113530,7 +112899,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -113538,7 +112907,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'401': *25
'403': *29
'404': *6
@@ -113582,7 +112951,7 @@ paths:
type: integer
secrets:
type: array
- items: &810
+ items: &805
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -113622,7 +112991,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *569
+ default: *566
headers:
Link: *47
x-github:
@@ -113698,7 +113067,7 @@ paths:
description: Response
content:
application/json:
- schema: *810
+ schema: *805
examples:
default:
value:
@@ -113844,7 +113213,7 @@ paths:
type: array
items: *283
examples:
- default: *811
+ default: *806
'401': *25
'403': *29
'404': *6
@@ -113996,7 +113365,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'304': *37
'500': *40
'401': *25
@@ -114054,7 +113423,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'401': *25
'403': *29
'404': *6
@@ -114111,7 +113480,7 @@ paths:
description: Response
content:
application/json:
- schema: &812
+ schema: &807
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -114152,7 +113521,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &813
+ default: &808
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -114197,9 +113566,9 @@ paths:
description: Response
content:
application/json:
- schema: *812
+ schema: *807
examples:
- default: *813
+ default: *808
'404': *6
x-github:
githubCloudOnly: false
@@ -114236,9 +113605,9 @@ paths:
type: integer
machines:
type: array
- items: *814
+ items: *809
examples:
- default: *815
+ default: *810
'304': *37
'500': *40
'401': *25
@@ -114317,13 +113686,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *467
+ repository: *464
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *567
- required: *568
+ properties: *564
+ required: *565
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -115105,7 +114474,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'304': *37
'500': *40
'400': *14
@@ -115145,7 +114514,7 @@ paths:
application/json:
schema: *376
examples:
- default: *566
+ default: *563
'500': *40
'401': *25
'403': *29
@@ -115177,7 +114546,7 @@ paths:
type: array
items: *387
examples:
- default: &826
+ default: &821
value:
- id: 197
name: hello_docker
@@ -115278,7 +114647,7 @@ paths:
application/json:
schema:
type: array
- items: &816
+ items: &811
title: Email
description: Email
type: object
@@ -115343,9 +114712,9 @@ paths:
application/json:
schema:
type: array
- items: *816
+ items: *811
examples:
- default: &828
+ default: &823
value:
- email: octocat@github.com
verified: true
@@ -115420,7 +114789,7 @@ paths:
application/json:
schema:
type: array
- items: *816
+ items: *811
examples:
default:
value:
@@ -115676,7 +115045,7 @@ paths:
application/json:
schema:
type: array
- items: &817
+ items: &812
title: GPG Key
description: A unique encryption key
type: object
@@ -115807,7 +115176,7 @@ paths:
- subkeys
- revoked
examples:
- default: &842
+ default: &837
value:
- id: 3
name: Octocat's GPG Key
@@ -115892,9 +115261,9 @@ paths:
description: Response
content:
application/json:
- schema: *817
+ schema: *812
examples:
- default: &818
+ default: &813
value:
id: 3
name: Octocat's GPG Key
@@ -115951,7 +115320,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &819
+ - &814
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -115963,9 +115332,9 @@ paths:
description: Response
content:
application/json:
- schema: *817
+ schema: *812
examples:
- default: *818
+ default: *813
'404': *6
'304': *37
'403': *29
@@ -115988,7 +115357,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *819
+ - *814
responses:
'204':
description: Response
@@ -116293,7 +115662,7 @@ paths:
required: true
content:
application/json:
- schema: *652
+ schema: *649
examples:
default:
value:
@@ -116443,7 +115812,7 @@ paths:
application/json:
schema:
type: array
- items: &820
+ items: &815
title: Key
description: Key
type: object
@@ -116544,9 +115913,9 @@ paths:
description: Response
content:
application/json:
- schema: *820
+ schema: *815
examples:
- default: &821
+ default: &816
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -116579,15 +115948,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *683
+ - *680
responses:
'200':
description: Response
content:
application/json:
- schema: *820
+ schema: *815
examples:
- default: *821
+ default: *816
'404': *6
'304': *37
'403': *29
@@ -116610,7 +115979,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *683
+ - *680
responses:
'204':
description: Response
@@ -116643,7 +116012,7 @@ paths:
application/json:
schema:
type: array
- items: &822
+ items: &817
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -116711,7 +116080,7 @@ paths:
- account
- plan
examples:
- default: &823
+ default: &818
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -116773,9 +116142,9 @@ paths:
application/json:
schema:
type: array
- items: *822
+ items: *817
examples:
- default: *823
+ default: *818
headers:
Link: *47
'304': *37
@@ -117784,7 +117153,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository
parameters:
- *382
- - *824
+ - *819
responses:
'204':
description: Response
@@ -117899,7 +117268,7 @@ paths:
- docker
- nuget
- container
- - *825
+ - *820
- *19
- *17
responses:
@@ -117911,8 +117280,8 @@ paths:
type: array
items: *387
examples:
- default: *826
- '400': *827
+ default: *821
+ '400': *822
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -117941,7 +117310,7 @@ paths:
application/json:
schema: *387
examples:
- default: &843
+ default: &838
value:
id: 40201
name: octo-name
@@ -118303,9 +117672,9 @@ paths:
application/json:
schema:
type: array
- items: *816
+ items: *811
examples:
- default: *828
+ default: *823
headers:
Link: *47
'304': *37
@@ -118418,7 +117787,7 @@ paths:
type: array
items: *78
examples:
- default: &835
+ default: &830
summary: Default response
value:
- id: 1296269
@@ -118722,9 +118091,9 @@ paths:
description: Response
content:
application/json:
- schema: *467
+ schema: *464
examples:
- default: *469
+ default: *466
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -118762,9 +118131,9 @@ paths:
application/json:
schema:
type: array
- items: *654
+ items: *651
examples:
- default: *829
+ default: *824
headers:
Link: *47
'304': *37
@@ -118843,7 +118212,7 @@ paths:
application/json:
schema:
type: array
- items: &830
+ items: &825
title: Social account
description: Social media account
type: object
@@ -118858,7 +118227,7 @@ paths:
- provider
- url
examples:
- default: &831
+ default: &826
value:
- provider: twitter
url: https://twitter.com/github
@@ -118920,9 +118289,9 @@ paths:
application/json:
schema:
type: array
- items: *830
+ items: *825
examples:
- default: *831
+ default: *826
'422': *15
'304': *37
'404': *6
@@ -119009,7 +118378,7 @@ paths:
application/json:
schema:
type: array
- items: &832
+ items: &827
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -119029,7 +118398,7 @@ paths:
- title
- created_at
examples:
- default: &857
+ default: &852
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -119093,9 +118462,9 @@ paths:
description: Response
content:
application/json:
- schema: *832
+ schema: *827
examples:
- default: &833
+ default: &828
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -119125,7 +118494,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &834
+ - &829
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -119137,9 +118506,9 @@ paths:
description: Response
content:
application/json:
- schema: *832
+ schema: *827
examples:
- default: *833
+ default: *828
'404': *6
'304': *37
'403': *29
@@ -119162,7 +118531,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *834
+ - *829
responses:
'204':
description: Response
@@ -119191,7 +118560,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &858
+ - &853
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
@@ -119216,11 +118585,11 @@ paths:
type: array
items: *78
examples:
- default-response: *835
+ default-response: *830
application/vnd.github.v3.star+json:
schema:
type: array
- items: &859
+ items: &854
title: Starred Repository
description: Starred Repository
type: object
@@ -119376,8 +118745,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response if this repository is starred by you
@@ -119405,8 +118774,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -119430,8 +118799,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *462
- - *463
+ - *459
+ - *460
responses:
'204':
description: Response
@@ -119589,10 +118958,10 @@ paths:
application/json:
schema:
oneOf:
- - *809
- - *808
+ - *804
+ - *803
examples:
- default-response: &837
+ default-response: &832
summary: Default response
value:
login: octocat
@@ -119627,7 +118996,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &838
+ response-with-git-hub-plan-information: &833
summary: Response with GitHub plan information
value:
login: octocat
@@ -119749,7 +119118,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users
parameters:
- - *836
+ - *831
- *17
responses:
'200':
@@ -119798,11 +119167,11 @@ paths:
application/json:
schema:
oneOf:
- - *809
- - *808
+ - *804
+ - *803
examples:
- default-response: *837
- response-with-git-hub-plan-information: *838
+ default-response: *832
+ response-with-git-hub-plan-information: *833
'404': *6
x-github:
githubCloudOnly: false
@@ -119852,8 +119221,8 @@ paths:
required:
- subject_digests
examples:
- default: *839
- withPredicateType: *840
+ default: *834
+ withPredicateType: *835
responses:
'200':
description: Response
@@ -119906,7 +119275,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *841
+ default: *836
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -120111,7 +119480,7 @@ paths:
initiator:
type: string
examples:
- default: *509
+ default: *506
'201':
description: Response
content:
@@ -120152,7 +119521,7 @@ paths:
type: array
items: *387
examples:
- default: *826
+ default: *821
'403': *29
'401': *25
x-github:
@@ -120536,9 +119905,9 @@ paths:
application/json:
schema:
type: array
- items: *817
+ items: *812
examples:
- default: *842
+ default: *837
headers:
Link: *47
x-github:
@@ -120642,7 +120011,7 @@ paths:
application/json:
schema: *22
examples:
- default: *651
+ default: *648
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120766,7 +120135,7 @@ paths:
- docker
- nuget
- container
- - *825
+ - *820
- *142
- *19
- *17
@@ -120779,10 +120148,10 @@ paths:
type: array
items: *387
examples:
- default: *826
+ default: *821
'403': *29
'401': *25
- '400': *827
+ '400': *822
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120812,7 +120181,7 @@ paths:
application/json:
schema: *387
examples:
- default: *843
+ default: *838
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -121161,7 +120530,7 @@ paths:
type: array
items: *409
examples:
- default: *844
+ default: *839
headers:
Link: *47
'304': *37
@@ -121221,7 +120590,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *845
+ items: *840
required:
- name
- data_type
@@ -121237,7 +120606,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *846
+ iteration_configuration: *841
required:
- name
- data_type
@@ -121259,8 +120628,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *847
- iteration_field: *848
+ single_select_field: *842
+ iteration_field: *843
responses:
'201':
description: Response
@@ -121268,11 +120637,11 @@ paths:
application/json:
schema: *409
examples:
- text_field: *849
- number_field: *850
- date_field: *851
- single_select_field: *852
- iteration_field: *853
+ text_field: *844
+ number_field: *845
+ date_field: *846
+ single_select_field: *847
+ iteration_field: *848
'304': *37
'403': *29
'401': *25
@@ -121294,7 +120663,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user
parameters:
- *405
- - *854
+ - *849
- *142
responses:
'200':
@@ -121303,7 +120672,7 @@ paths:
application/json:
schema: *409
examples:
- default: *855
+ default: *850
headers:
Link: *47
'304': *37
@@ -121653,7 +121022,7 @@ paths:
parameters:
- *405
- *142
- - *856
+ - *851
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -121932,9 +121301,9 @@ paths:
application/json:
schema:
type: array
- items: *830
+ items: *825
examples:
- default: *831
+ default: *826
headers:
Link: *47
x-github:
@@ -121964,9 +121333,9 @@ paths:
application/json:
schema:
type: array
- items: *832
+ items: *827
examples:
- default: *857
+ default: *852
headers:
Link: *47
x-github:
@@ -121991,7 +121360,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *142
- - *858
+ - *853
- *110
- *17
- *19
@@ -122003,11 +121372,11 @@ paths:
schema:
anyOf:
- type: array
- items: *859
+ items: *854
- type: array
items: *78
examples:
- default-response: *835
+ default-response: *830
headers:
Link: *47
x-github:
@@ -122166,7 +121535,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &860
+ enterprise: &855
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -122224,7 +121593,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &861
+ installation: &856
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -122243,7 +121612,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &862
+ organization: &857
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -122303,13 +121672,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &863
+ repository: &858
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: &900
+ properties: &895
id:
description: Unique identifier of the repository
example: 42
@@ -122992,7 +122361,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &901
+ required: &896
- archive_url
- assignees_url
- blobs_url
@@ -123143,10 +122512,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -123222,11 +122591,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- rule: &864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ rule: &859
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -123449,11 +122818,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- rule: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ rule: *859
sender: *4
required:
- action
@@ -123636,11 +123005,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- rule: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ rule: *859
sender: *4
required:
- action
@@ -123713,7 +123082,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &884
+ schema: &879
title: Exemption request cancellation event
type: object
properties:
@@ -123721,11 +123090,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: &865
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: &860
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -123994,7 +123363,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &866
+ items: &861
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -124104,7 +123473,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &885
+ schema: &880
title: Exemption request completed event
type: object
properties:
@@ -124112,11 +123481,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
sender: *4
required:
- action
@@ -124188,7 +123557,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &882
+ schema: &877
title: Exemption request created event
type: object
properties:
@@ -124196,11 +123565,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
sender: *4
required:
- action
@@ -124272,7 +123641,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &886
+ schema: &881
title: Exemption response dismissed event
type: object
properties:
@@ -124280,12 +123649,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
- exemption_response: *866
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
+ exemption_response: *861
sender: *4
required:
- action
@@ -124359,7 +123728,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &883
+ schema: &878
title: Exemption response submitted event
type: object
properties:
@@ -124367,12 +123736,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- exemption_request: *865
- exemption_response: *866
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ exemption_request: *860
+ exemption_response: *861
sender: *4
required:
- action
@@ -124456,7 +123825,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &868
+ check_run: &863
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -124547,7 +123916,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *867
+ deployment: *862
details_url:
example: https://example.com
type: string
@@ -124632,10 +124001,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
sender: *4
required:
- check_run
@@ -125028,11 +124397,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *868
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ check_run: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
sender: *4
required:
- check_run
@@ -125428,11 +124797,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *868
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ check_run: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
requested_action:
description: The action requested by the user.
type: object
@@ -125837,11 +125206,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *868
- installation: *861
- enterprise: *860
- organization: *862
- repository: *863
+ check_run: *863
+ installation: *856
+ enterprise: *855
+ organization: *857
+ repository: *858
sender: *4
required:
- check_run
@@ -126818,10 +126187,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -127515,10 +126884,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -128206,10 +127575,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -128375,7 +127744,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128520,20 +127889,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &869
+ commit_oid: &864
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: *860
- installation: *861
- organization: *862
- ref: &870
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: &865
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: *863
+ repository: *858
sender: *4
required:
- action
@@ -128698,7 +128067,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128928,12 +128297,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -129028,7 +128397,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129199,12 +128568,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -129370,7 +128739,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -129536,12 +128905,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -129640,7 +129009,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129815,16 +129184,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
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: *863
+ repository: *858
sender: *4
required:
- action
@@ -129921,7 +129290,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -130061,12 +129430,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *869
- enterprise: *860
- installation: *861
- organization: *862
- ref: *870
- repository: *863
+ commit_oid: *864
+ enterprise: *855
+ installation: *856
+ organization: *857
+ ref: *865
+ repository: *858
sender: *4
required:
- action
@@ -130232,7 +129601,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *538
+ dismissed_comment: *535
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -130377,10 +129746,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -130635,10 +130004,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -130718,18 +130087,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *862
- pusher_type: &871
+ organization: *857
+ pusher_type: &866
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &872
+ ref: &867
description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference)
resource.
type: string
@@ -130739,7 +130108,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *863
+ repository: *858
sender: *4
required:
- ref
@@ -130822,9 +130191,9 @@ x-webhooks:
enum:
- created
definition: *156
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -130909,9 +130278,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -130989,9 +130358,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *156
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -131069,9 +130438,9 @@ x-webhooks:
enum:
- updated
definition: *156
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -131148,10 +130517,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- repository: *863
- organization: *862
+ enterprise: *855
+ installation: *856
+ repository: *858
+ organization: *857
sender: *4
new_property_values:
type: array
@@ -131236,18 +130605,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- pusher_type: *871
- ref: *872
+ enterprise: *855
+ installation: *856
+ organization: *857
+ pusher_type: *866
+ ref: *867
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *863
+ repository: *858
sender: *4
required:
- ref
@@ -131331,11 +130700,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131419,11 +130788,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131507,11 +130876,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131593,11 +130962,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131679,11 +131048,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131766,11 +131135,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131852,11 +131221,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *600
- installation: *861
- organization: *862
- enterprise: *860
- repository: *863
+ alert: *597
+ installation: *856
+ organization: *857
+ enterprise: *855
+ repository: *858
sender: *4
required:
- action
@@ -131933,9 +131302,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- key: &873
+ enterprise: *855
+ installation: *856
+ key: &868
description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -131971,8 +131340,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -132049,11 +131418,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- key: *873
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ key: *868
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -132614,12 +131983,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: &877
+ workflow: &872
title: Workflow
type: object
nullable: true
@@ -133345,13 +132714,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *606
+ deployment: *603
pull_requests:
type: array
- items: *704
- repository: *863
- organization: *862
- installation: *861
+ items: *701
+ repository: *858
+ organization: *857
+ installation: *856
sender: *4
responses:
'200':
@@ -133422,7 +132791,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &874
+ approver: &869
type: object
properties:
avatar_url:
@@ -133465,11 +132834,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- reviewers: &875
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ reviewers: &870
type: array
items:
type: object
@@ -133548,7 +132917,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &876
+ workflow_job_run: &871
type: object
properties:
conclusion:
@@ -134279,18 +133648,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *874
+ approver: *869
comment:
type: string
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- reviewers: *875
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ reviewers: *870
sender: *4
since:
type: string
- workflow_job_run: *876
+ workflow_job_run: *871
workflow_job_runs:
type: array
items:
@@ -134994,13 +134363,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *860
+ enterprise: *855
environment:
type: string
- installation: *861
- organization: *862
- repository: *863
- requestor: &887
+ installation: *856
+ organization: *857
+ repository: *858
+ requestor: &882
title: User
type: object
nullable: true
@@ -136899,12 +136268,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Deployment Workflow Run
type: object
@@ -137584,7 +136953,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &880
+ answer: &875
type: object
properties:
author_association:
@@ -137741,11 +137110,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -137872,11 +137241,11 @@ x-webhooks:
- from
required:
- category
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -137959,11 +137328,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138045,7 +137414,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &879
+ comment: &874
type: object
properties:
author_association:
@@ -138202,11 +137571,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138289,12 +137658,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *879
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ comment: *874
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138389,12 +137758,12 @@ x-webhooks:
- from
required:
- body
- comment: *879
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ comment: *874
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138478,11 +137847,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138564,11 +137933,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138668,11 +138037,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138754,10 +138123,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *878
- enterprise: *860
- installation: *861
- label: &881
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ label: &876
title: Label
type: object
properties:
@@ -138789,8 +138158,8 @@ x-webhooks:
- color
- default
- description
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138873,11 +138242,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -138959,11 +138328,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139045,11 +138414,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139134,16 +138503,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *878
- new_repository: *863
+ new_discussion: *873
+ new_repository: *858
required:
- new_discussion
- new_repository
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139226,10 +138595,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *878
- old_answer: *880
- organization: *862
- repository: *863
+ discussion: *873
+ old_answer: *875
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139311,12 +138680,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *878
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139399,11 +138768,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139485,11 +138854,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *878
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ discussion: *873
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -139558,7 +138927,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139621,7 +138990,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139684,7 +139053,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *884
+ schema: *879
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139747,7 +139116,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139810,7 +139179,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139876,7 +139245,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *884
+ schema: *879
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139942,7 +139311,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *885
+ schema: *880
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140008,7 +139377,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140074,7 +139443,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *886
+ schema: *881
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140140,7 +139509,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140205,7 +139574,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *884
+ schema: *879
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140270,7 +139639,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *885
+ schema: *880
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140335,7 +139704,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *882
+ schema: *877
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140400,7 +139769,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *886
+ schema: *881
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140466,7 +139835,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *883
+ schema: *878
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -140533,7 +139902,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *860
+ enterprise: *855
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository)
resource.
@@ -141193,9 +140562,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- forkee
@@ -141341,9 +140710,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pages:
description: The pages that were updated.
type: array
@@ -141380,7 +140749,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *863
+ repository: *858
sender: *4
required:
- pages
@@ -141456,10 +140825,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: &888
+ organization: *857
+ repositories: &883
description: An array of repository objects that the installation
can access.
type: array
@@ -141485,8 +140854,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *863
- requester: *887
+ repository: *858
+ requester: *882
sender: *4
required:
- action
@@ -141561,11 +140930,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -141641,11 +141010,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -141721,10 +141090,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories_added: &889
+ organization: *857
+ repositories_added: &884
description: An array of repository objects, which were added to
the installation.
type: array
@@ -141770,15 +141139,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *863
- repository_selection: &890
+ repository: *858
+ repository_selection: &885
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *887
+ requester: *882
sender: *4
required:
- action
@@ -141857,10 +141226,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories_added: *889
+ organization: *857
+ repositories_added: *884
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -141887,9 +141256,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *863
- repository_selection: *890
- requester: *887
+ repository: *858
+ repository_selection: *885
+ requester: *882
sender: *4
required:
- action
@@ -141968,11 +141337,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -142151,10 +141520,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
target_type:
type: string
@@ -142233,11 +141602,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *860
+ enterprise: *855
installation: *22
- organization: *862
- repositories: *888
- repository: *863
+ organization: *857
+ repositories: *883
+ repository: *858
requester:
nullable: true
sender: *4
@@ -142489,8 +141858,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -143284,8 +142653,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143634,8 +143003,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -143715,7 +143084,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &891
+ comment: &886
title: issue comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment)
itself.
@@ -143880,8 +143249,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -144671,8 +144040,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145023,8 +144392,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -145104,7 +144473,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &920
+ changes: &915
description: The changes to the comment.
type: object
properties:
@@ -145116,9 +144485,9 @@ x-webhooks:
type: string
required:
- from
- comment: *891
- enterprise: *860
- installation: *861
+ comment: *886
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -145911,8 +145280,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -146261,8 +145630,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146352,9 +145721,9 @@ x-webhooks:
type: number
blocking_issue: *220
blocking_issue_repo: *78
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146443,9 +145812,9 @@ x-webhooks:
type: number
blocking_issue: *220
blocking_issue_repo: *78
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146533,9 +145902,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146624,9 +145993,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -146706,10 +146075,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *887
- enterprise: *860
- installation: *861
- issue: &894
+ assignee: *882
+ enterprise: *855
+ installation: *856
+ issue: &889
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -147498,11 +146867,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -147619,8 +146988,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -147700,8 +147069,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -148495,11 +147864,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148751,8 +148120,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -148831,8 +148200,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -149617,11 +148986,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -149737,8 +149106,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -149817,8 +149186,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -150625,11 +149994,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -150724,7 +150093,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &892
+ milestone: &887
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -150862,8 +150231,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -150962,8 +150331,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -151752,11 +151121,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -151873,9 +151242,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *881
- organization: *862
- repository: *863
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -151955,8 +151324,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -152744,11 +152113,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -152865,9 +152234,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *881
- organization: *862
- repository: *863
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -152947,8 +152316,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -153760,11 +153129,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -153858,8 +153227,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -153938,8 +153307,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -154745,11 +154114,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -154843,9 +154212,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *892
- organization: *862
- repository: *863
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -155713,11 +155082,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -156279,8 +155648,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -157069,11 +156438,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -157189,8 +156558,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -157270,9 +156639,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *860
- installation: *861
- issue: &893
+ enterprise: *855
+ installation: *856
+ issue: &888
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -158055,11 +157424,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -158175,8 +157544,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -158255,8 +157624,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -159066,11 +158435,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -159165,8 +158534,8 @@ x-webhooks:
user_view_type:
type: string
type: *371
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160032,11 +159401,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -160620,11 +159989,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *860
- installation: *861
- issue: *893
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *888
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160704,12 +160073,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *860
- installation: *861
- issue: *894
+ enterprise: *855
+ installation: *856
+ issue: *889
type: *371
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160790,7 +160159,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &923
+ assignee: &918
title: User
type: object
nullable: true
@@ -160860,11 +160229,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *860
- installation: *861
- issue: *894
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *889
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -160943,12 +160312,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *860
- installation: *861
- issue: *894
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *889
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -161028,8 +160397,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -161839,11 +161208,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *796
- issue_dependencies_summary: *797
+ sub_issues_summary: *793
+ issue_dependencies_summary: *794
issue_field_values:
type: array
- items: *798
+ items: *795
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -161937,8 +161306,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162018,11 +161387,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *860
- installation: *861
- issue: *893
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ issue: *888
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162101,12 +161470,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *860
- installation: *861
- issue: *894
+ enterprise: *855
+ installation: *856
+ issue: *889
type: *371
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162186,11 +161555,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162268,11 +161637,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162382,11 +161751,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- label: *881
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ label: *876
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -162468,9 +161837,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: &895
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: &890
title: Marketplace Purchase
type: object
required:
@@ -162553,8 +161922,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *862
- previous_marketplace_purchase: &896
+ organization: *857
+ previous_marketplace_purchase: &891
title: Marketplace Purchase
type: object
properties:
@@ -162634,7 +162003,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -162714,10 +162083,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: *895
- organization: *862
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: *890
+ organization: *857
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162800,7 +162169,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -162882,10 +162251,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: *895
- organization: *862
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: *890
+ organization: *857
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162967,7 +162336,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -163048,8 +162417,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -163131,9 +162500,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *862
- previous_marketplace_purchase: *896
- repository: *863
+ organization: *857
+ previous_marketplace_purchase: *891
+ repository: *858
sender: *4
required:
- action
@@ -163213,12 +162582,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *860
- installation: *861
- marketplace_purchase: *895
- organization: *862
- previous_marketplace_purchase: *896
- repository: *863
+ enterprise: *855
+ installation: *856
+ marketplace_purchase: *890
+ organization: *857
+ previous_marketplace_purchase: *891
+ repository: *858
sender: *4
required:
- action
@@ -163320,11 +162689,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -163424,11 +162793,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -163507,11 +162876,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -163589,11 +162958,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163669,7 +163038,7 @@ x-webhooks:
required:
- login
- id
- team: &897
+ team: &892
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -163892,11 +163261,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *860
- installation: *861
- member: *887
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ member: *882
+ organization: *857
+ repository: *858
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163973,7 +163342,7 @@ x-webhooks:
required:
- login
- id
- team: *897
+ team: *892
required:
- action
- scope
@@ -164055,8 +163424,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *861
- merge_group: &899
+ installation: *856
+ merge_group: &894
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -164075,15 +163444,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *898
+ head_commit: *893
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164169,10 +163538,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *861
- merge_group: *899
- organization: *862
- repository: *863
+ installation: *856
+ merge_group: *894
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164245,7 +163614,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
+ enterprise: *855
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -164354,16 +163723,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -164444,11 +163813,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
- milestone: *892
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164527,9 +163896,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- milestone: &902
+ enterprise: *855
+ installation: *856
+ milestone: &897
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -164666,8 +164035,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164746,11 +164115,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- milestone: *892
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164860,11 +164229,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- milestone: *892
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *887
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -164944,11 +164313,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *860
- installation: *861
- milestone: *902
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ milestone: *897
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165027,11 +164396,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *887
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ blocked_user: *882
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165110,11 +164479,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *887
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ blocked_user: *882
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165190,7 +164559,7 @@ x-webhooks:
enum:
- created
definition: *150
- enterprise: *860
+ enterprise: *855
sender: *4
required:
- action
@@ -165270,8 +164639,8 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
sender: *4
required:
- action
@@ -165344,8 +164713,8 @@ x-webhooks:
enum:
- updated
definition: *150
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
sender: *4
required:
- action
@@ -165417,9 +164786,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
new_property_values:
type: array
@@ -165507,9 +164876,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- membership: &903
+ enterprise: *855
+ installation: *856
+ membership: &898
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -165616,8 +164985,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165695,11 +165064,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *860
- installation: *861
- membership: *903
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ membership: *898
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -165778,8 +165147,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -165895,10 +165264,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
- user: *887
+ user: *882
required:
- action
- invitation
@@ -165976,11 +165345,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *860
- installation: *861
- membership: *903
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ membership: *898
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -166067,11 +165436,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *860
- installation: *861
- membership: *903
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ membership: *898
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -166147,9 +165516,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
package:
description: Information about the package.
type: object
@@ -166648,7 +166017,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &904
+ items: &899
title: Ruby Gems metadata
type: object
properties:
@@ -166743,7 +166112,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -166819,9 +166188,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
package:
description: Information about the package.
type: object
@@ -167174,7 +166543,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *904
+ items: *899
source_url:
type: string
format: uri
@@ -167244,7 +166613,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -167421,12 +166790,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *860
+ enterprise: *855
id:
type: integer
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- id
@@ -167503,7 +166872,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &905
+ personal_access_token_request: &900
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -167649,10 +167018,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *860
- organization: *862
+ enterprise: *855
+ organization: *857
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167729,11 +167098,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *905
- enterprise: *860
- organization: *862
+ personal_access_token_request: *900
+ enterprise: *855
+ organization: *857
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167809,11 +167178,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *905
- enterprise: *860
- organization: *862
+ personal_access_token_request: *900
+ enterprise: *855
+ organization: *857
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167888,11 +167257,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *905
- organization: *862
- enterprise: *860
+ personal_access_token_request: *900
+ organization: *857
+ enterprise: *855
sender: *4
- installation: *861
+ installation: *856
required:
- action
- personal_access_token_request
@@ -167997,7 +167366,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *906
+ last_response: *901
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -168029,8 +167398,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
zen:
description: Random string of GitHub zen.
@@ -168275,10 +167644,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *860
- installation: *861
- organization: *862
- project_card: &907
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_card: &902
title: Project Card
type: object
properties:
@@ -168397,7 +167766,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -168478,11 +167847,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- project_card: *907
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_card: *902
+ repository: *858
sender: *4
required:
- action
@@ -168562,9 +167931,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
project_card:
title: Project Card
type: object
@@ -168692,8 +168061,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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -168787,11 +168156,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *860
- installation: *861
- organization: *862
- project_card: *907
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_card: *902
+ repository: *858
sender: *4
required:
- action
@@ -168885,9 +168254,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
project_card:
allOf:
- title: Project Card
@@ -169077,7 +168446,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -169157,10 +168526,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
- organization: *862
- project: &909
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: &904
title: Project
type: object
properties:
@@ -169284,7 +168653,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -169364,10 +168733,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- project_column: &908
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: &903
title: Project Column
type: object
properties:
@@ -169406,7 +168775,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -169485,18 +168854,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- project_column: *908
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: *903
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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -169586,11 +168955,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- project_column: *908
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: *903
+ repository: *858
sender: *4
required:
- action
@@ -169670,11 +169039,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *860
- installation: *861
- organization: *862
- project_column: *908
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project_column: *903
+ repository: *858
sender: *4
required:
- action
@@ -169754,11 +169123,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
+ repository: *858
sender: *4
required:
- action
@@ -169838,18 +169207,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
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: *900
- required: *901
+ properties: *895
+ required: *896
nullable: true
sender: *4
required:
@@ -169951,11 +169320,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
+ repository: *858
sender: *4
required:
- action
@@ -170034,11 +169403,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *860
- installation: *861
- organization: *862
- project: *909
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ project: *904
+ repository: *858
sender: *4
required:
- action
@@ -170119,8 +169488,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170202,8 +169571,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170285,8 +169654,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170404,8 +169773,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -170489,7 +169858,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &913
+ changes: &908
type: object
properties:
archived_at:
@@ -170503,9 +169872,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *861
- organization: *862
- projects_v2_item: &910
+ installation: *856
+ organization: *857
+ projects_v2_item: &905
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -170640,9 +170009,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -170724,9 +170093,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -170807,9 +170176,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -170915,7 +170284,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &911
+ - &906
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -170937,7 +170306,7 @@ x-webhooks:
required:
- id
- name
- - &912
+ - &907
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -170971,8 +170340,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *911
- - *912
+ - *906
+ - *907
required:
- field_value
- type: object
@@ -170988,9 +170357,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -171085,9 +170454,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *861
- organization: *862
- projects_v2_item: *910
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -171170,10 +170539,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *913
- installation: *861
- organization: *862
- projects_v2_item: *910
+ changes: *908
+ installation: *856
+ organization: *857
+ projects_v2_item: *905
sender: *4
required:
- action
@@ -171255,8 +170624,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
projects_v2: *403
sender: *4
required:
@@ -171338,14 +170707,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *861
- organization: *862
- projects_v2_status_update: &916
+ installation: *856
+ organization: *857
+ projects_v2_status_update: &911
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *914
- required: *915
+ properties: *909
+ required: *910
sender: *4
required:
- action
@@ -171426,9 +170795,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *861
- organization: *862
- projects_v2_status_update: *916
+ installation: *856
+ organization: *857
+ projects_v2_status_update: *911
sender: *4
required:
- action
@@ -171564,9 +170933,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *861
- organization: *862
- projects_v2_status_update: *916
+ installation: *856
+ organization: *857
+ projects_v2_status_update: *911
sender: *4
required:
- action
@@ -171637,10 +171006,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- repository
@@ -171717,13 +171086,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *887
- enterprise: *860
- installation: *861
- number: &917
+ assignee: *882
+ enterprise: *855
+ installation: *856
+ number: &912
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -174006,7 +173375,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -174088,11 +173457,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -176370,7 +175739,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -176452,11 +175821,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -178734,7 +178103,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -178816,13 +178185,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: &918
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: &913
allOf:
- - *704
+ - *701
- type: object
properties:
allow_auto_merge:
@@ -178884,7 +178253,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -178965,12 +178334,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -179050,11 +178419,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *860
- milestone: *686
- number: *917
- organization: *862
- pull_request: &919
+ enterprise: *855
+ milestone: *683
+ number: *912
+ organization: *857
+ pull_request: &914
title: Pull Request
type: object
properties:
@@ -181317,7 +180686,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -181396,11 +180765,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -183682,7 +183051,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -183806,12 +183175,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -183891,11 +183260,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -186162,7 +185531,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -186242,11 +185611,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *860
- installation: *861
- label: *881
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ label: *876
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -188528,7 +187897,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -188609,10 +187978,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -190892,7 +190261,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -190972,12 +190341,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *860
- milestone: *686
- number: *917
- organization: *862
- pull_request: *919
- repository: *863
+ enterprise: *855
+ milestone: *683
+ number: *912
+ organization: *857
+ pull_request: *914
+ repository: *858
sender: *4
required:
- action
@@ -191056,12 +190425,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -191142,12 +190511,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -191227,12 +190596,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
- pull_request: *918
- repository: *863
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
+ pull_request: *913
+ repository: *858
sender: *4
required:
- action
@@ -191598,9 +190967,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
type: object
properties:
@@ -193770,7 +193139,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -193850,7 +193219,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &921
+ comment: &916
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -194135,9 +193504,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
type: object
properties:
@@ -196295,7 +195664,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -196375,11 +195744,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *920
- comment: *921
- enterprise: *860
- installation: *861
- organization: *862
+ changes: *915
+ comment: *916
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
type: object
properties:
@@ -198540,7 +197909,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -198621,9 +197990,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -200796,7 +200165,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
+ repository: *858
review:
description: The review that was affected.
type: object
@@ -201043,9 +200412,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -203099,8 +202468,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
- review: &922
+ repository: *858
+ review: &917
description: The review that was affected.
type: object
properties:
@@ -203333,12 +202702,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -205621,7 +204990,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_reviewer:
title: User
type: object
@@ -205705,12 +205074,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -208000,7 +207369,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -208192,12 +207561,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -210482,7 +209851,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_reviewer:
title: User
type: object
@@ -210567,12 +209936,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *860
- installation: *861
+ enterprise: *855
+ installation: *856
number:
description: The pull request number.
type: integer
- organization: *862
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -212848,7 +212217,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -213029,9 +212398,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -215206,8 +214575,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
- review: *922
+ repository: *858
+ review: *917
sender: *4
required:
- action
@@ -215287,9 +214656,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -217359,7 +216728,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
thread:
type: object
@@ -217746,9 +217115,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
pull_request:
title: Simple Pull Request
type: object
@@ -219804,7 +219173,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *863
+ repository: *858
sender: *4
thread:
type: object
@@ -220194,10 +219563,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -222468,7 +221837,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -222550,11 +221919,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *923
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ assignee: *918
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -224837,7 +224206,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -224916,11 +224285,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *860
- installation: *861
- label: *881
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ label: *876
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -227193,7 +226562,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -227274,10 +226643,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *860
- installation: *861
- number: *917
- organization: *862
+ enterprise: *855
+ installation: *856
+ number: *912
+ organization: *857
pull_request:
title: Pull Request
type: object
@@ -229542,7 +228911,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -229742,7 +229111,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *860
+ enterprise: *855
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -229834,8 +229203,8 @@ x-webhooks:
- url
- author
- committer
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -230410,9 +229779,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
registry_package:
type: object
properties:
@@ -230858,7 +230227,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *904
+ items: *899
summary:
type: string
tag_name:
@@ -230912,7 +230281,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -230990,9 +230359,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
registry_package:
type: object
properties:
@@ -231300,7 +230669,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *904
+ items: *899
summary:
type: string
tag_name:
@@ -231349,7 +230718,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -231426,10 +230795,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- release: &924
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: &919
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -231747,7 +231116,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -231824,11 +231193,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- release: *924
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *919
+ repository: *858
sender: *4
required:
- action
@@ -231945,11 +231314,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *860
- installation: *861
- organization: *862
- release: *924
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *919
+ repository: *858
sender: *4
required:
- action
@@ -232027,9 +231396,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
release:
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
@@ -232351,7 +231720,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -232427,10 +231796,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
- release: &925
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: &920
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -232749,7 +232118,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *863
+ repository: *858
sender: *4
required:
- action
@@ -232825,11 +232194,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *860
- installation: *861
- organization: *862
- release: *924
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *919
+ repository: *858
sender: *4
required:
- action
@@ -232905,11 +232274,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *860
- installation: *861
- organization: *862
- release: *925
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ release: *920
+ repository: *858
sender: *4
required:
- action
@@ -232985,11 +232354,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- repository_advisory: *756
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ repository_advisory: *753
sender: *4
required:
- action
@@ -233065,11 +232434,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- repository_advisory: *756
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ repository_advisory: *753
sender: *4
required:
- action
@@ -233145,10 +232514,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233225,10 +232594,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233306,10 +232675,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233393,10 +232762,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233508,10 +232877,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233583,10 +232952,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
status:
type: string
@@ -233667,10 +233036,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233747,10 +233116,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233844,10 +233213,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -233927,10 +233296,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
repository_ruleset: *190
sender: *4
required:
@@ -234009,10 +233378,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
repository_ruleset: *190
sender: *4
required:
@@ -234091,10 +233460,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
repository_ruleset: *190
changes:
type: object
@@ -234156,16 +233525,16 @@ x-webhooks:
properties:
added:
type: array
- items: *724
+ items: *721
deleted:
type: array
- items: *724
+ items: *721
updated:
type: array
items:
type: object
properties:
- rule: *724
+ rule: *721
changes:
type: object
properties:
@@ -234399,10 +233768,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234480,10 +233849,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234561,7 +233930,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &926
+ alert: &921
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -234682,10 +234051,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234891,10 +234260,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -234972,11 +234341,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *926
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *921
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235175,10 +234544,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235256,7 +234625,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &927
+ alert: &922
type: object
properties:
number: *127
@@ -235375,10 +234744,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235456,11 +234825,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235541,11 +234910,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *927
- installation: *861
- location: *928
- organization: *862
- repository: *863
+ alert: *922
+ installation: *856
+ location: *923
+ organization: *857
+ repository: *858
sender: *4
required:
- location
@@ -235783,11 +235152,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235865,11 +235234,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -235947,11 +235316,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -236029,12 +235398,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *927
+ alert: *922
assignee: *4
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -236112,11 +235481,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *927
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ alert: *922
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -236242,10 +235611,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *863
- enterprise: *860
- installation: *861
- organization: *862
+ repository: *858
+ enterprise: *855
+ installation: *856
+ organization: *857
sender: *4
required:
- action
@@ -236323,11 +235692,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- security_advisory: &929
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ security_advisory: &924
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -236510,11 +235879,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
- security_advisory: *929
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
+ security_advisory: *924
sender: *4
required:
- action
@@ -236587,10 +235956,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -236775,10 +236144,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *419
- enterprise: *860
- installation: *861
- organization: *862
- repository: *467
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *464
sender: *4
required:
- changes
@@ -236856,12 +236225,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: &930
+ sponsorship: &925
type: object
properties:
created_at:
@@ -237162,12 +236531,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- sponsorship
@@ -237255,12 +236624,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- changes
@@ -237337,17 +236706,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &931
+ effective_date: &926
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: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- sponsorship
@@ -237421,7 +236790,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &932
+ changes: &927
type: object
properties:
tier:
@@ -237465,13 +236834,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *931
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ effective_date: *926
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- changes
@@ -237548,13 +236917,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *932
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ changes: *927
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- sponsorship: *930
+ sponsorship: *925
required:
- action
- changes
@@ -237628,10 +236997,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -237714,10 +237083,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -238137,15 +237506,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *860
+ enterprise: *855
id:
description: The unique identifier of the status.
type: integer
- installation: *861
+ installation: *856
name:
type: string
- organization: *862
- repository: *863
+ organization: *857
+ repository: *858
sender: *4
sha:
description: The Commit SHA.
@@ -238260,9 +237629,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238352,9 +237721,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238444,9 +237813,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238536,9 +237905,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *220
- installation: *861
- organization: *862
- repository: *863
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -238615,12 +237984,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- team: &933
+ team: &928
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -238843,9 +238212,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -239303,7 +238672,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -239379,9 +238748,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -239839,7 +239208,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -239916,9 +239285,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -240376,7 +239745,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -240520,9 +239889,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -240980,7 +240349,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- changes
@@ -241058,9 +240427,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *860
- installation: *861
- organization: *862
+ enterprise: *855
+ installation: *856
+ organization: *857
repository:
title: Repository
description: A git repository
@@ -241518,7 +240887,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *933
+ team: *928
required:
- action
- team
@@ -241594,10 +240963,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
required:
- action
@@ -241670,16 +241039,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *860
+ enterprise: *855
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *861
- organization: *862
+ installation: *856
+ organization: *857
ref:
type: string
- repository: *863
+ repository: *858
sender: *4
workflow:
type: string
@@ -241761,10 +241130,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
allOf:
@@ -242001,7 +241370,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242080,10 +241449,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
allOf:
@@ -242343,7 +241712,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242422,10 +241791,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
type: object
@@ -242560,7 +241929,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242639,10 +242008,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
workflow_job:
type: object
@@ -242778,7 +242147,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *606
+ deployment: *603
required:
- action
- repository
@@ -242858,12 +242227,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Workflow Run
type: object
@@ -243862,12 +243231,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Workflow Run
type: object
@@ -244851,12 +244220,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *860
- installation: *861
- organization: *862
- repository: *863
+ enterprise: *855
+ installation: *856
+ organization: *857
+ repository: *858
sender: *4
- workflow: *877
+ workflow: *872
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json
index 3ea5670d2..cde38262a 100644
--- a/descriptions/ghec/ghec.2022-11-28.json
+++ b/descriptions/ghec/ghec.2022-11-28.json
@@ -40975,307 +40975,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
"summary": "List a connection between an external group and a team",
@@ -80650,307 +80349,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -141733,15 +141131,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -141805,8 +141194,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -141820,86 +141207,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -314517,8 +313824,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -314570,8 +313875,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -314622,8 +313925,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -314649,149 +313950,6 @@
}
}
},
- "team-discussion-comment-items": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "team-discussion-comment": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
- "team-discussion-comment-2": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
"team-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -336699,15 +335857,6 @@
"type": "integer"
}
},
- "comment-number": {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml
index 57be6dda4..07efac65e 100644
--- a/descriptions/ghec/ghec.2022-11-28.yaml
+++ b/descriptions/ghec/ghec.2022-11-28.yaml
@@ -29571,217 +29571,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -58373,227 +58162,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -103767,13 +103335,6 @@ components:
the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -103825,8 +103386,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -103838,72 +103397,6 @@ components:
- title
- updated_at
- url
- team-discussion-comment:
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -235535,8 +235028,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -235583,8 +235074,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -235631,8 +235120,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -235655,135 +235142,6 @@ components:
hooray: 0
eyes: 1
rocket: 1
- team-discussion-comment-items:
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment:
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment-2:
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
team-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -254652,13 +254010,6 @@ components:
required: true
schema:
type: integer
- comment-number:
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json
index 3ea5670d2..cde38262a 100644
--- a/descriptions/ghec/ghec.json
+++ b/descriptions/ghec/ghec.json
@@ -40975,307 +40975,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- },
- "delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
"summary": "List a connection between an external group and a team",
@@ -80650,307 +80349,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
- "get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussion-comments-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion-comment"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like apples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
- "get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "description": "The discussion comment's body text."
- }
- },
- "required": [
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "body": "Do you like pineapples?"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion-comment"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-comment-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-comment-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- },
- {
- "$ref": "#/components/parameters/comment-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussion-comments"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -141733,15 +141131,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -141805,8 +141194,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -141820,86 +141207,6 @@
"url"
]
},
- "team-discussion-comment": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -314517,8 +313824,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -314570,8 +313875,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -314622,8 +313925,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -314649,149 +313950,6 @@
}
}
},
- "team-discussion-comment-items": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "team-discussion-comment": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
- "team-discussion-comment-2": {
- "value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- },
"team-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -336699,15 +335857,6 @@
"type": "integer"
}
},
- "comment-number": {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml
index 57be6dda4..07efac65e 100644
--- a/descriptions/ghec/ghec.yaml
+++ b/descriptions/ghec/ghec.yaml
@@ -29571,217 +29571,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -58373,227 +58162,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion-comment"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-comment-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- - "$ref": "#/components/parameters/comment-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -103767,13 +103335,6 @@ components:
the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -103825,8 +103386,6 @@ components:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -103838,72 +103397,6 @@ components:
- title
- updated_at
- url
- team-discussion-comment:
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -235535,8 +235028,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -235583,8 +235074,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -235631,8 +235120,6 @@ components:
body: Hi! This is an area for us to collaborate as a team.
body_html: "Hi! This is an area for us to collaborate as a team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -235655,135 +235142,6 @@ components:
hooray: 0
eyes: 1
rocket: 1
- team-discussion-comment-items:
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment:
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- team-discussion-comment-2:
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
team-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -254652,13 +254010,6 @@ components:
required: true
schema:
type: integer
- comment-number:
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
index e6537df05..614ab4185 100644
--- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
+++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
@@ -182324,15 +182324,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -182442,8 +182433,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -182485,8 +182474,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -182750,15 +182737,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -182868,8 +182846,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -182909,8 +182885,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -183140,14 +183114,406 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-25T18:56:31Z"
},
- "comments_url": {
+ "last_edited_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ },
+ "number": {
+ "description": "The unique sequence number of a team discussion.",
+ "example": 42,
+ "type": "integer"
+ },
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-25T18:56:31Z"
+ },
+ "url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ },
+ "reactions": {
+ "title": "Reaction Rollup",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "html_url",
+ "pinned",
+ "private",
+ "node_id",
+ "number",
+ "team_url",
+ "title",
+ "updated_at",
+ "url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "author": {
+ "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
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ },
+ "patch": {
+ "summary": "Update a discussion",
+ "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "description": "The number that identifies the discussion.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
+ "nullable": true
+ },
+ "body": {
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string",
+ "example": "Hi! This is an area for us to collaborate as a team
"
+ },
+ "body_version": {
+ "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
+ "example": "0307116bbf7ced493b8d8a346c650b71",
+ "type": "string"
},
"created_at": {
"type": "string",
@@ -183258,8 +183624,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -183299,18 +183663,16 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
+ "last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
"node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
"pinned": false,
"private": false,
"team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
+ "title": "Welcome to our first team post",
+ "updated_at": "2018-01-26T18:22:20Z",
"url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
"url": "https://api.github.com/teams/2343027/discussions/1/reactions",
@@ -183338,16 +183700,16 @@
"subcategory": "discussions"
}
},
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "delete": {
+ "summary": "Delete a discussion",
+ "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-in-org",
+ "operationId": "teams/delete-discussion-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion"
},
"parameters": [
{
@@ -183378,27 +183740,185 @@
}
}
],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
+ "get": {
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
"requestBody": {
- "required": false,
+ "required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
}
- }
+ },
+ "required": [
+ "group_id"
+ ]
},
"examples": {
"default": {
"value": {
- "title": "Welcome to our first team post"
+ "group_id": 123
}
}
}
@@ -183411,333 +183931,145 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
"type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
"type": "integer"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
"type": "string"
},
"updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
},
- "eyes": {
- "type": "integer"
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
},
- "rocket": {
- "type": "integer"
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
}
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
}
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
}
}
}
@@ -183746,22 +184078,22 @@
}
},
"x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "external-groups"
}
},
"delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-in-org",
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -183781,15 +184113,6 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -183798,24 +184121,24 @@
}
},
"x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "external-groups"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "/orgs/{org}/teams/{team_slug}/members": {
"get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -183837,26 +184160,18 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
- "asc",
- "desc"
+ "member",
+ "maintainer",
+ "all"
],
- "default": "desc"
+ "default": "all"
}
},
{
@@ -183886,250 +184201,126 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Simple User",
+ "description": "A GitHub user.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "email": {
+ "nullable": true,
"type": "string"
},
- "body_html": {
+ "login": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "octocat"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
},
- "created_at": {
+ "node_id": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "MDQ6VXNlcjE="
},
- "last_edited_at": {
+ "avatar_url": {
"type": "string",
- "format": "date-time",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/octocat"
},
- "node_id": {
+ "followers_url": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
- "url": {
+ "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/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/users/octocat/subscriptions"
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "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": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
"html_url",
+ "id",
"node_id",
- "number",
- "updated_at",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
"url"
]
}
@@ -184138,49 +184329,24 @@
"default": {
"value": [
{
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "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
}
]
}
@@ -184201,19 +184367,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -184235,35 +184403,141 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "if user has no team membership"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "body": "Do you like apples?"
+ "role": "maintainer"
}
}
}
@@ -184271,331 +184545,138 @@
}
},
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ },
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/orgs/{org}/teams/{team_slug}/projects": {
"get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List team projects",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-in-org",
+ "operationId": "teams/list-projects-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects"
},
"parameters": [
{
@@ -184617,17 +184698,347 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Team Project",
+ "description": "A team's access to a project.",
+ "type": "object",
+ "properties": {
+ "owner_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "columns_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
+ "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"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "type": "boolean"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "read": {
+ "type": "boolean"
+ },
+ "write": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at",
+ "permissions"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "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
+ },
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": false,
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
+ "get": {
+ "summary": "Check team permissions for a project",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/check-permissions-for-project-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -184641,11 +185052,42 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Project",
+ "description": "A team's access to a project.",
"type": "object",
"properties": {
- "author": {
+ "owner_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "columns_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -184767,131 +185209,73 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "created_at": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "updated_at": {
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "private": {
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "type": "boolean"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "permissions": {
"type": "object",
"properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
+ "read": {
+ "type": "boolean"
},
- "eyes": {
- "type": "integer"
+ "write": {
+ "type": "boolean"
},
- "rocket": {
- "type": "integer"
+ "admin": {
+ "type": "boolean"
}
},
"required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "read",
+ "write",
+ "admin"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
+ "owner_url",
+ "url",
"html_url",
+ "columns_url",
+ "id",
"node_id",
+ "name",
+ "body",
"number",
+ "state",
+ "creator",
+ "created_at",
"updated_at",
- "url"
+ "permissions"
]
},
"examples": {
"default": {
"value": {
- "author": {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -184911,53 +185295,45 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": false,
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
}
}
}
}
}
}
+ },
+ "404": {
+ "description": "Not Found if project is not managed by this team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team project permissions",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-in-org",
+ "operationId": "teams/add-or-update-project-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
},
"parameters": [
{
@@ -184979,17 +185355,8 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -184998,25 +185365,29 @@
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "permission": {
"type": "string",
- "description": "The discussion comment's body text."
- }
+ "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
},
- "required": [
- "body"
- ]
+ "nullable": true
},
"examples": {
"default": {
+ "summary": "Updates the permissions for the team to write for the project",
"value": {
- "body": "Do you like pineapples?"
+ "permission": "write"
}
}
}
@@ -185024,304 +185395,29 @@
}
},
"responses": {
- "200": {
- "description": "Response",
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if the project is not owned by the organization",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "message": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "documentation_url": {
"type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
}
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
+ }
},
"examples": {
- "default": {
+ "response-if-the-project-is-not-owned-by-the-organization": {
"value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "message": "Must have admin rights to Repository.",
+ "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
}
}
}
@@ -185333,19 +185429,22 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove a project from a team",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-in-org",
+ "operationId": "teams/remove-project-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team"
},
"parameters": [
{
@@ -185367,17 +185466,8 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -185394,396 +185484,24 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/external-groups": {
- "get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
},
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
+ "deprecated": true
}
},
- "/orgs/{org}/teams/{team_slug}/members": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-members-in-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
},
"parameters": [
{
@@ -185804,21 +185522,6 @@
"type": "string"
}
},
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
{
"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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
@@ -185846,737 +185549,642 @@
"schema": {
"type": "array",
"items": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
"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
+ "example": 1296269
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
- "avatar_url": {
+ "name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
+ "example": "https://github.com/octocat/Hello-World"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "This your first repo!",
"nullable": true
},
+ "fork": {
+ "type": "boolean"
+ },
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/repos/octocat/Hello-World"
},
- "html_url": {
+ "archive_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
- "followers_url": {
+ "assignees_url": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
- "following_url": {
+ "blobs_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
- "gists_url": {
+ "branches_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
- "starred_url": {
+ "collaborators_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
- "subscriptions_url": {
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
- "organizations_url": {
+ "deployments_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
- "repos_url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
},
- "received_events_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
- "type": {
+ "git_commits_url": {
"type": "string",
- "example": "User"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
- "site_admin": {
- "type": "boolean"
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
- "starred_at": {
+ "git_tags_url": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
- "user_view_type": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
"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"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "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
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- },
- "422": {
- "description": "Unprocessable Entity if you attempt to add an organization to a team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "delete": {
- "summary": "Remove team membership for a user",
- "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/remove-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/projects": {
- "get": {
- "summary": "List team projects",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-projects-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Project",
- "description": "A team's access to a project.",
- "type": "object",
- "properties": {
- "owner_url": {
- "type": "string"
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
- "url": {
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
"type": "string"
},
- "html_url": {
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
"type": "string"
},
- "columns_url": {
+ "mirror_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
"type": "string"
},
- "id": {
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
"type": "integer"
},
- "node_id": {
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer"
+ },
+ "default_branch": {
"type": "string"
},
- "name": {
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
"type": "string"
},
- "body": {
+ "pushed_at": {
"type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
"nullable": true
},
- "number": {
- "type": "integer"
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
},
- "state": {
- "type": "string"
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "permissions": {
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
+ "admin": {
+ "type": "boolean"
},
- "login": {
- "type": "string",
- "example": "octocat"
+ "maintain": {
+ "type": "boolean"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "push": {
+ "type": "boolean"
},
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
+ "triage": {
+ "type": "boolean"
},
- "avatar_url": {
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "code_of_conduct": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
+ "example": "contributor_covenant"
},
- "gravatar_id": {
+ "name": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "Contributor Covenant"
},
"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"
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
},
- "events_url": {
+ "body": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
},
- "received_events_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
},
- "type": {
- "type": "string",
- "example": "User"
+ "name": {
+ "type": "string"
},
- "site_admin": {
- "type": "boolean"
+ "spdx_id": {
+ "type": "string"
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "url": {
+ "type": "string"
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "node_id": {
+ "type": "string"
}
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
+ "nullable": true
},
- "created_at": {
- "type": "string"
+ "forks": {
+ "type": "integer",
+ "example": 0
},
- "updated_at": {
- "type": "string"
+ "open_issues": {
+ "type": "integer",
+ "example": 0
},
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
- "type": "string"
+ "watchers": {
+ "type": "integer",
+ "example": 0
},
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "allow_forking": {
"type": "boolean"
},
- "permissions": {
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "security_and_analysis": {
+ "nullable": true,
"type": "object",
"properties": {
- "read": {
- "type": "boolean"
+ "advanced_security": {
+ "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
},
- "write": {
- "type": "boolean"
+ "dependabot_security_updates": {
+ "description": "Enable or disable Dependabot security updates for the repository.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The enablement status of Dependabot security updates for the repository.",
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
},
- "admin": {
- "type": "boolean"
+ "secret_scanning": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_push_protection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
}
- },
- "required": [
- "read",
- "write",
- "admin"
- ]
+ }
}
},
"required": [
- "owner_url",
- "url",
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
"html_url",
- "columns_url",
"id",
"node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
"name",
- "body",
- "number",
- "state",
- "creator",
- "created_at",
- "updated_at",
- "permissions"
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
]
}
},
@@ -186584,17 +186192,11 @@
"default": {
"value": [
{
- "owner_url": "https://api.github.com/orgs/octocat",
- "url": "https://api.github.com/projects/1002605",
- "html_url": "https://github.com/orgs/api-playground/projects/1",
- "columns_url": "https://api.github.com/projects/1002605/columns",
- "id": 1002605,
- "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year.",
- "number": 1,
- "state": "open",
- "creator": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -186614,14 +186216,94 @@
"type": "User",
"site_admin": false
},
- "created_at": "2011-04-11T20:09:31Z",
- "updated_at": "2014-03-04T18:58:10Z",
- "organization_permission": "write",
"private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "has_discussions": false,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
"permissions": {
- "read": true,
- "write": true,
- "admin": false
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "security_and_analysis": {
+ "advanced_security": {
+ "status": "enabled"
+ },
+ "secret_scanning": {
+ "status": "enabled"
+ },
+ "secret_scanning_push_protection": {
+ "status": "disabled"
+ }
}
}
]
@@ -186643,24 +186325,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
}
},
- "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
+ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
"get": {
- "summary": "Check team permissions for a project",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "summary": "Check team permissions for a repository",
+ "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
"tags": [
"teams"
],
- "operationId": "teams/check-permissions-for-project-in-org",
+ "operationId": "teams/check-permissions-for-repo-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository"
},
"parameters": [
{
@@ -186682,64 +186361,134 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
"responses": {
"200": {
- "description": "Response",
+ "description": "Alternative response with repository permissions",
"content": {
"application/json": {
"schema": {
- "title": "Team Project",
- "description": "A team's access to a project.",
+ "title": "Team Repository",
+ "description": "A team's access to a repository.",
"type": "object",
"properties": {
- "owner_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "html_url": {
- "type": "string"
- },
- "columns_url": {
- "type": "string"
- },
"id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
"type": "integer"
},
"node_id": {
- "type": "string"
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"name": {
- "type": "string"
- },
- "body": {
+ "description": "The name of the repository.",
"type": "string",
- "nullable": true
- },
- "number": {
- "type": "integer"
+ "example": "Team Environment"
},
- "state": {
- "type": "string"
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "license": {
+ "title": "License Simple",
+ "description": "License Simple",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
"email": {
"nullable": true,
@@ -186854,73 +186603,463 @@
"subscriptions_url",
"type",
"url"
- ]
+ ],
+ "nullable": true
},
- "created_at": {
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
"type": "string"
},
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
"updated_at": {
- "type": "string"
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
},
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
"type": "string"
},
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
- "type": "boolean"
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
},
- "permissions": {
- "type": "object",
- "properties": {
- "read": {
- "type": "boolean"
- },
- "write": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "read",
- "write",
- "admin"
- ]
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
}
},
"required": [
- "owner_url",
- "url",
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
"html_url",
- "columns_url",
"id",
"node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
"name",
- "body",
- "number",
- "state",
- "creator",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
"created_at",
- "updated_at",
- "permissions"
+ "updated_at"
]
},
"examples": {
- "default": {
+ "alternative-response-with-repository-permissions": {
"value": {
- "owner_url": "https://api.github.com/orgs/octocat",
- "url": "https://api.github.com/projects/1002605",
- "html_url": "https://github.com/orgs/api-playground/projects/1",
- "columns_url": "https://api.github.com/projects/1002605/columns",
- "id": 1002605,
- "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year.",
- "number": 1,
- "state": "open",
- "creator": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -186940,45 +187079,135 @@
"type": "User",
"site_admin": false
},
- "created_at": "2011-04-11T20:09:31Z",
- "updated_at": "2014-03-04T18:58:10Z",
- "organization_permission": "write",
"private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
"permissions": {
- "read": true,
- "write": true,
- "admin": false
- }
+ "admin": false,
+ "maintain": false,
+ "push": false,
+ "triage": false,
+ "pull": true
+ },
+ "role_name": "read",
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
}
}
}
}
}
},
+ "204": {
+ "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
+ },
"404": {
- "description": "Not Found if project is not managed by this team"
+ "description": "Not Found if team does not have permission for the repository"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
},
"put": {
- "summary": "Add or update team project permissions",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "summary": "Add or update team repository permissions",
+ "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
"tags": [
"teams"
],
- "operationId": "teams/add-or-update-project-permissions-in-org",
+ "operationId": "teams/add-or-update-repo-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions"
},
"parameters": [
{
@@ -187000,12 +187229,21 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
@@ -187018,21 +187256,15 @@
"properties": {
"permission": {
"type": "string",
- "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"",
- "enum": [
- "read",
- "write",
- "admin"
- ]
+ "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."
}
- },
- "nullable": true
+ }
},
"examples": {
"default": {
- "summary": "Updates the permissions for the team to write for the project",
+ "summary": "Adding a team to an organization repository with the write role",
"value": {
- "permission": "write"
+ "permission": "push"
}
}
}
@@ -187042,54 +187274,25 @@
"responses": {
"204": {
"description": "Response"
- },
- "403": {
- "description": "Forbidden if the project is not owned by the organization",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- },
- "examples": {
- "response-if-the-project-is-not-owned-by-the-organization": {
- "value": {
- "message": "Must have admin rights to Repository.",
- "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
- }
- }
- }
- }
- }
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
},
"delete": {
- "summary": "Remove a project from a team",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "summary": "Remove a repository from a team",
+ "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
"tags": [
"teams"
],
- "operationId": "teams/remove-project-in-org",
+ "operationId": "teams/remove-repo-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team"
},
"parameters": [
{
@@ -187111,12 +187314,21 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
@@ -187129,24 +187341,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
}
},
- "/orgs/{org}/teams/{team_slug}/repos": {
+ "/orgs/{org}/teams/{team_slug}/teams": {
"get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
+ "summary": "List child teams",
+ "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
"tags": [
"teams"
],
- "operationId": "teams/list-repos-in-org",
+ "operationId": "teams/list-child-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams"
},
"parameters": [
{
@@ -187188,768 +187397,252 @@
],
"responses": {
"200": {
- "description": "Response",
+ "description": "if child teams exist",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
+ "type": "integer"
},
"node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ "type": "string"
},
"name": {
- "type": "string",
- "example": "Hello-World"
+ "type": "string"
},
- "full_name": {
+ "slug": {
+ "type": "string"
+ },
+ "description": {
"type": "string",
- "example": "octocat/Hello-World"
+ "nullable": true
},
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "pull": {
+ "type": "boolean"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "triage": {
+ "type": "boolean"
},
- "login": {
- "type": "string",
- "example": "octocat"
+ "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"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
+ },
+ "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",
- "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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
+ ],
"nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- },
- "clone_url": {
- "type": "string"
- },
- "mirror_url": {
- "type": "string",
- "nullable": true
- },
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
- "type": "string"
- },
- "homepage": {
- "type": "string",
- "nullable": true
- },
- "language": {
- "type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer"
- },
- "stargazers_count": {
- "type": "integer"
- },
- "watchers_count": {
- "type": "integer"
- },
- "size": {
- "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
- "type": "integer"
- },
- "default_branch": {
- "type": "string"
- },
- "open_issues_count": {
- "type": "integer"
- },
- "is_template": {
- "type": "boolean"
- },
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "has_issues": {
- "type": "boolean"
- },
- "has_projects": {
- "type": "boolean"
- },
- "has_wiki": {
- "type": "boolean"
- },
- "has_pages": {
- "type": "boolean"
- },
- "has_downloads": {
- "type": "boolean"
- },
- "has_discussions": {
- "type": "boolean"
- },
- "archived": {
- "type": "boolean"
- },
- "disabled": {
- "type": "boolean"
- },
- "visibility": {
- "type": "string"
- },
- "pushed_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- }
- },
- "role_name": {
- "type": "string",
- "example": "admin"
- },
- "temp_clone_token": {
- "type": "string"
- },
- "delete_branch_on_merge": {
- "type": "boolean"
- },
- "subscribers_count": {
- "type": "integer"
- },
- "network_count": {
- "type": "integer"
- },
- "code_of_conduct": {
- "title": "Code Of Conduct",
- "description": "Code Of Conduct",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "contributor_covenant"
- },
- "name": {
- "type": "string",
- "example": "Contributor Covenant"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
- },
- "body": {
- "type": "string",
- "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "nullable": true
- }
- },
- "required": [
- "url",
- "html_url",
- "key",
- "name"
- ]
- },
- "license": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "spdx_id": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "node_id": {
- "type": "string"
- }
- },
- "nullable": true
- },
- "forks": {
- "type": "integer",
- "example": 0
- },
- "open_issues": {
- "type": "integer",
- "example": 0
- },
- "watchers": {
- "type": "integer",
- "example": 0
- },
- "allow_forking": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "security_and_analysis": {
- "nullable": true,
- "type": "object",
- "properties": {
- "advanced_security": {
- "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- },
- "dependabot_security_updates": {
- "description": "Enable or disable Dependabot security updates for the repository.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The enablement status of Dependabot security updates for the repository.",
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- },
- "secret_scanning": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- },
- "secret_scanning_push_protection": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- }
- }
}
},
"required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
"id",
"node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
+ "url",
+ "members_url",
"name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url"
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent",
+ "type"
]
}
},
"examples": {
- "default": {
+ "response-if-child-teams-exist": {
"value": [
{
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "login": "octocat",
+ "id": 2,
+ "node_id": "MDQ6VGVhbTI=",
+ "url": "https://api.github.com/teams/2",
+ "name": "Original Roster",
+ "slug": "original-roster",
+ "description": "Started it all.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/2/members{/member}",
+ "repositories_url": "https://api.github.com/teams/2/repos",
+ "parent": {
"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
- },
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
- "has_discussions": false,
- "archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "push": false,
- "pull": true
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos"
},
- "security_and_analysis": {
- "advanced_security": {
- "status": "enabled"
- },
- "secret_scanning": {
- "status": "enabled"
- },
- "secret_scanning_push_protection": {
- "status": "disabled"
- }
- }
+ "html_url": "https://github.com/orgs/rails/teams/core"
}
]
}
@@ -187974,17 +187667,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
- "get": {
- "summary": "Check team permissions for a repository",
- "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
+ "/orgs/{org}/{security_product}/{enablement}": {
+ "post": {
+ "summary": "Enable or disable a security feature for an organization",
+ "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.",
"tags": [
- "teams"
+ "orgs"
],
- "operationId": "teams/check-permissions-for-repo-in-org",
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
},
"parameters": [
{
@@ -187997,136 +187690,135 @@
}
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "name": "security_product",
"in": "path",
+ "description": "The security feature to enable or disable.",
"required": true,
"schema": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "dependency_graph",
+ "dependabot_alerts",
+ "dependabot_security_updates",
+ "advanced_security",
+ "code_scanning_default_setup",
+ "secret_scanning",
+ "secret_scanning_push_protection"
+ ]
}
},
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "enablement",
"in": "path",
+ "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.",
"required": true,
"schema": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "enable_all",
+ "disable_all"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "query_suite": {
+ "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.",
+ "type": "string",
+ "enum": [
+ "default",
+ "extended"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
}
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Action started"
},
+ "422": {
+ "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "orgs",
+ "deprecationDate": "2024-07-22",
+ "removalDate": "2025-07-22"
+ },
+ "deprecated": true
+ }
+ },
+ "/projects/columns/cards/{card_id}": {
+ "get": {
+ "summary": "Get a project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "projects-classic"
+ ],
+ "operationId": "projects-classic/get-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card"
+ },
+ "parameters": [
{
- "name": "repo",
- "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer"
}
}
],
"responses": {
"200": {
- "description": "Alternative response with repository permissions",
+ "description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Repository",
- "description": "A team's access to a repository.",
+ "title": "Project Card",
+ "description": "Project cards represent a scope of work.",
"type": "object",
"properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/cards/1478"
+ },
"id": {
- "description": "Unique identifier of the repository",
+ "description": "The project card's ID",
"example": 42,
- "type": "integer"
+ "type": "integer",
+ "format": "int64"
},
"node_id": {
"type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "description": "The name of the repository.",
- "type": "string",
- "example": "Team Environment"
+ "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
},
- "full_name": {
+ "note": {
"type": "string",
- "example": "octocat/Hello-World"
- },
- "license": {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "mit"
- },
- "name": {
- "type": "string",
- "example": "MIT License"
- },
- "url": {
- "type": "string",
- "nullable": true,
- "format": "uri",
- "example": "https://api.github.com/licenses/mit"
- },
- "spdx_id": {
- "type": "string",
- "nullable": true,
- "example": "MIT"
- },
- "node_id": {
- "type": "string",
- "example": "MDc6TGljZW5zZW1pdA=="
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ],
+ "example": "Add payload for delete Project column",
"nullable": true
},
- "forks": {
- "type": "integer"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "role_name": {
- "type": "string",
- "example": "admin"
- },
- "owner": {
+ "creator": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -188251,460 +187943,451 @@
],
"nullable": true
},
- "private": {
- "description": "Whether the repository is private or public.",
- "default": false,
- "type": "boolean"
- },
- "html_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
+ "format": "date-time",
+ "example": "2016-09-05T14:21:06Z"
},
- "description": {
+ "updated_at": {
"type": "string",
- "example": "This your first repo!",
- "nullable": true
+ "format": "date-time",
+ "example": "2016-09-05T14:20:22Z"
},
- "fork": {
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "example": false,
"type": "boolean"
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ "column_name": {
+ "type": "string"
},
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ "project_id": {
+ "type": "string"
},
- "downloads_url": {
+ "column_url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ "example": "https://api.github.com/projects/columns/367"
},
- "events_url": {
+ "content_url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
},
- "forks_url": {
+ "project_url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ "example": "https://api.github.com/projects/120"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "note",
+ "url",
+ "column_url",
+ "project_url",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/projects/columns/cards/1478",
+ "id": 1478,
+ "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
+ "note": "Add payload for delete Project column",
+ "creator": {
+ "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
+ },
+ "created_at": "2016-09-05T14:21:06Z",
+ "updated_at": "2016-09-05T14:20:22Z",
+ "archived": false,
+ "column_url": "https://api.github.com/projects/columns/367",
+ "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
+ "project_url": "https://api.github.com/projects/120"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
},
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ "documentation_url": {
+ "type": "string"
},
- "git_url": {
- "type": "string",
- "example": "git:github.com/octocat/Hello-World.git"
+ "url": {
+ "type": "string"
},
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
},
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ "documentation_url": {
+ "type": "string"
},
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ "url": {
+ "type": "string"
},
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string",
- "example": "git@github.com:octocat/Hello-World.git"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
},
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ "documentation_url": {
+ "type": "string"
},
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ "url": {
+ "type": "string"
},
- "teams_url": {
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update an existing project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "projects-classic"
+ ],
+ "operationId": "projects-classic/update-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card"
+ },
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "note": {
+ "description": "The project card's note",
+ "example": "Update all gems",
+ "type": "string",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "example": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Change the note on the card",
+ "value": {
+ "note": "Add payload for delete Project column"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Project Card",
+ "description": "Project cards represent a scope of work.",
+ "type": "object",
+ "properties": {
+ "url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ "example": "https://api.github.com/projects/columns/cards/1478"
},
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ "id": {
+ "description": "The project card's ID",
+ "example": 42,
+ "type": "integer",
+ "format": "int64"
},
- "clone_url": {
+ "node_id": {
"type": "string",
- "example": "https://github.com/octocat/Hello-World.git"
+ "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
},
- "mirror_url": {
+ "note": {
"type": "string",
- "format": "uri",
- "example": "git:git.example.com/octocat/Hello-World",
+ "example": "Add payload for delete Project column",
"nullable": true
},
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
- "type": "string",
- "format": "uri",
- "example": "https://svn.github.com/octocat/Hello-World"
- },
- "homepage": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com",
+ "creator": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
"nullable": true
},
- "language": {
+ "created_at": {
"type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer",
- "example": 9
- },
- "stargazers_count": {
- "type": "integer",
- "example": 80
- },
- "watchers_count": {
- "type": "integer",
- "example": 80
- },
- "size": {
- "type": "integer",
- "example": 108
+ "format": "date-time",
+ "example": "2016-09-05T14:21:06Z"
},
- "default_branch": {
- "description": "The default branch of the repository.",
+ "updated_at": {
"type": "string",
- "example": "master"
- },
- "open_issues_count": {
- "type": "integer",
- "example": 0
- },
- "is_template": {
- "description": "Whether this repository acts as a template that can be used to generate new repositories.",
- "default": false,
- "type": "boolean",
- "example": true
- },
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "has_issues": {
- "description": "Whether issues are enabled.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "has_projects": {
- "description": "Whether projects are enabled.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "has_wiki": {
- "description": "Whether the wiki is enabled.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "has_pages": {
- "type": "boolean"
- },
- "has_downloads": {
- "description": "Whether downloads are enabled.",
- "default": true,
- "type": "boolean",
- "example": true
+ "format": "date-time",
+ "example": "2016-09-05T14:20:22Z"
},
"archived": {
- "description": "Whether the repository is archived.",
- "default": false,
+ "description": "Whether or not the card is archived",
+ "example": false,
"type": "boolean"
},
- "disabled": {
- "type": "boolean",
- "description": "Returns whether or not this repository disabled."
+ "column_name": {
+ "type": "string"
},
- "visibility": {
- "description": "The repository visibility: public, private, or internal.",
- "default": "public",
+ "project_id": {
"type": "string"
},
- "pushed_at": {
+ "column_url": {
"type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367"
},
- "created_at": {
+ "content_url": {
"type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
+ "format": "uri",
+ "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
},
- "updated_at": {
+ "project_url": {
"type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
- "allow_rebase_merge": {
- "description": "Whether to allow rebase merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "temp_clone_token": {
- "type": "string"
- },
- "allow_squash_merge": {
- "description": "Whether to allow squash merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_auto_merge": {
- "description": "Whether to allow Auto-merge to be used on pull requests.",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "delete_branch_on_merge": {
- "description": "Whether to delete head branches when pull requests are merged",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "allow_merge_commit": {
- "description": "Whether to allow merge commits for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_forking": {
- "description": "Whether to allow forking this repo",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "web_commit_signoff_required": {
- "description": "Whether to require contributors to sign off on web-based commits",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "subscribers_count": {
- "type": "integer"
- },
- "network_count": {
- "type": "integer"
- },
- "open_issues": {
- "type": "integer"
- },
- "watchers": {
- "type": "integer"
- },
- "master_branch": {
- "type": "string"
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
}
},
"required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
"id",
"node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
+ "note",
"url",
- "clone_url",
- "default_branch",
- "forks",
- "forks_count",
- "git_url",
- "has_downloads",
- "has_issues",
- "has_projects",
- "has_wiki",
- "has_pages",
- "homepage",
- "language",
- "archived",
- "disabled",
- "mirror_url",
- "open_issues",
- "open_issues_count",
- "license",
- "pushed_at",
- "size",
- "ssh_url",
- "stargazers_count",
- "svn_url",
- "watchers",
- "watchers_count",
+ "column_url",
+ "project_url",
+ "creator",
"created_at",
"updated_at"
]
},
"examples": {
- "alternative-response-with-repository-permissions": {
+ "default": {
"value": {
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
+ "url": "https://api.github.com/projects/columns/cards/1478",
+ "id": 1478,
+ "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
+ "note": "Add payload for delete Project column",
+ "creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -188724,708 +188407,532 @@
"type": "User",
"site_admin": false
},
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
+ "created_at": "2016-09-05T14:21:06Z",
+ "updated_at": "2016-09-05T14:20:22Z",
"archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "maintain": false,
- "push": false,
- "triage": false,
- "pull": true
- },
- "role_name": "read",
- "allow_rebase_merge": true,
- "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
- "allow_squash_merge": true,
- "allow_auto_merge": false,
- "delete_branch_on_merge": true,
- "allow_merge_commit": true,
- "subscribers_count": 42,
- "network_count": 0,
- "license": {
- "key": "mit",
- "name": "MIT License",
- "url": "https://api.github.com/licenses/mit",
- "spdx_id": "MIT",
- "node_id": "MDc6TGljZW5zZW1pdA==",
- "html_url": "https://api.github.com/licenses/mit"
- },
- "forks": 1,
- "open_issues": 1,
- "watchers": 1
+ "column_url": "https://api.github.com/projects/columns/367",
+ "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
+ "project_url": "https://api.github.com/projects/120"
}
}
}
}
}
},
- "204": {
- "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
- },
- "404": {
- "description": "Not Found if team does not have permission for the repository"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- },
- "put": {
- "summary": "Add or update team repository permissions",
- "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-repo-permissions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
+ "304": {
+ "description": "Not modified"
},
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
},
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
},
- {
- "name": "repo",
- "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."
+ "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"
+ }
}
}
- },
- "examples": {
- "default": {
- "summary": "Adding a team to an organization repository with the write role",
- "value": {
- "permission": "push"
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error Simple",
+ "description": "Validation Error Simple",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
}
}
}
}
}
},
- "responses": {
- "204": {
- "description": "Response"
- }
- },
"x-github": {
- "githubCloudOnly": false,
+ "githubCloudOnly": true,
"enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
"delete": {
- "summary": "Remove a repository from a team",
- "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
+ "summary": "Delete a project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
- "teams"
+ "projects-classic"
],
- "operationId": "teams/remove-repo-in-org",
+ "operationId": "projects-classic/delete-card",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card"
},
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
},
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "304": {
+ "description": "Not modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
},
- {
- "name": "repo",
- "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "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"
+ }
+ }
+ }
+ }
}
}
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
},
"x-github": {
- "githubCloudOnly": false,
+ "githubCloudOnly": true,
"enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
}
},
- "/orgs/{org}/teams/{team_slug}/teams": {
- "get": {
- "summary": "List child teams",
- "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
+ "/projects/columns/cards/{card_id}/moves": {
+ "post": {
+ "summary": "Move a project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
- "teams"
+ "projects-classic"
],
- "operationId": "teams/list-child-in-org",
+ "operationId": "projects-classic/move-card",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card"
},
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
"in": "path",
"required": true,
"schema": {
- "type": "string"
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
+ "type": "integer"
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "position": {
+ "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.",
+ "example": "bottom",
+ "type": "string",
+ "pattern": "^(?:top|bottom|after:\\d+)$"
+ },
+ "column_id": {
+ "description": "The unique identifier of the column the card should be moved to",
+ "example": 42,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Move the card to the bottom of the column",
+ "value": {
+ "column_id": 42,
+ "position": "bottom"
+ }
+ }
+ }
+ }
+ }
+ },
"responses": {
- "200": {
- "description": "if child teams exist",
+ "201": {
+ "description": "Response",
"content": {
"application/json": {
"schema": {
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {},
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
"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",
+ "code": {
"type": "string"
},
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
+ "message": {
+ "type": "string"
},
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
+ "resource": {
+ "type": "string"
},
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
+ "field": {
+ "type": "string"
}
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "parent",
- "type"
- ]
- }
- },
- "examples": {
- "response-if-child-teams-exist": {
- "value": [
- {
- "id": 2,
- "node_id": "MDQ6VGVhbTI=",
- "url": "https://api.github.com/teams/2",
- "name": "Original Roster",
- "slug": "original-roster",
- "description": "Started it all.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/2/members{/member}",
- "repositories_url": "https://api.github.com/teams/2/repos",
- "parent": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos"
- },
- "html_url": "https://github.com/orgs/rails/teams/core"
+ }
}
- ]
+ }
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
+ }
+ },
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
"schema": {
- "type": "string"
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- }
- },
- "/orgs/{org}/{security_product}/{enablement}": {
- "post": {
- "summary": "Enable or disable a security feature for an organization",
- "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.",
- "tags": [
- "orgs"
- ],
- "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "security_product",
- "in": "path",
- "description": "The security feature to enable or disable.",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "dependency_graph",
- "dependabot_alerts",
- "dependabot_security_updates",
- "advanced_security",
- "code_scanning_default_setup",
- "secret_scanning",
- "secret_scanning_push_protection"
- ]
- }
},
- {
- "name": "enablement",
- "in": "path",
- "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "enable_all",
- "disable_all"
- ]
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "query_suite": {
- "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.",
- "type": "string",
- "enum": [
- "default",
- "extended"
- ]
+ "503": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
}
- },
- "examples": {
- "default": {
- "value": null
- }
}
}
- }
- },
- "responses": {
- "204": {
- "description": "Action started"
},
"422": {
- "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
- "githubCloudOnly": false,
+ "githubCloudOnly": true,
"enabledForGitHubApps": true,
- "previews": [],
- "category": "orgs",
- "subcategory": "orgs",
- "deprecationDate": "2024-07-22",
- "removalDate": "2025-07-22"
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
},
"deprecated": true
}
},
- "/projects/columns/cards/{card_id}": {
+ "/projects/columns/{column_id}": {
"get": {
- "summary": "Get a project card",
+ "summary": "Get a project column",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"projects-classic"
],
- "operationId": "projects-classic/get-card",
+ "operationId": "projects-classic/get-column",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column"
},
"parameters": [
{
- "name": "card_id",
- "description": "The unique identifier of the card.",
+ "name": "column_id",
+ "description": "The unique identifier of the column.",
"in": "path",
"required": true,
"schema": {
@@ -189439,200 +188946,57 @@
"content": {
"application/json": {
"schema": {
- "title": "Project Card",
- "description": "Project cards represent a scope of work.",
+ "title": "Project Column",
+ "description": "Project columns contain cards of work.",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/projects/columns/cards/1478"
+ "example": "https://api.github.com/projects/columns/367"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367/cards"
},
"id": {
- "description": "The project card's ID",
+ "description": "The unique identifier of the project column",
"example": 42,
- "type": "integer",
- "format": "int64"
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
- },
- "note": {
- "type": "string",
- "example": "Add payload for delete Project column",
- "nullable": true
+ "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2016-09-05T14:21:06Z"
+ "example": "2016-09-05T14:18:44Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2016-09-05T14:20:22Z"
- },
- "archived": {
- "description": "Whether or not the card is archived",
- "example": false,
- "type": "boolean"
- },
- "column_name": {
- "type": "string"
- },
- "project_id": {
- "type": "string"
- },
- "column_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "content_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
+ "example": "2016-09-05T14:22:28Z"
}
},
"required": [
"id",
"node_id",
- "note",
"url",
- "column_url",
"project_url",
- "creator",
+ "cards_url",
+ "name",
"created_at",
"updated_at"
]
@@ -189640,36 +189004,14 @@
"examples": {
"default": {
"value": {
- "url": "https://api.github.com/projects/columns/cards/1478",
- "id": 1478,
- "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
- "note": "Add payload for delete Project column",
- "creator": {
- "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
- },
- "created_at": "2016-09-05T14:21:06Z",
- "updated_at": "2016-09-05T14:20:22Z",
- "archived": false,
- "column_url": "https://api.github.com/projects/columns/367",
- "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
- "project_url": "https://api.github.com/projects/120"
+ "url": "https://api.github.com/projects/columns/367",
+ "project_url": "https://api.github.com/projects/120",
+ "cards_url": "https://api.github.com/projects/columns/367/cards",
+ "id": 367,
+ "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
+ "name": "To Do",
+ "created_at": "2016-09-05T14:18:44Z",
+ "updated_at": "2016-09-05T14:22:28Z"
}
}
}
@@ -189705,8 +189047,8 @@
}
}
},
- "401": {
- "description": "Requires authentication",
+ "404": {
+ "description": "Resource not found",
"content": {
"application/json": {
"schema": {
@@ -189731,8 +189073,8 @@
}
}
},
- "404": {
- "description": "Resource not found",
+ "401": {
+ "description": "Requires authentication",
"content": {
"application/json": {
"schema": {
@@ -189759,30 +189101,30 @@
}
},
"x-github": {
- "githubCloudOnly": true,
+ "githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "projects-classic",
- "subcategory": "cards",
+ "subcategory": "columns",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
},
"patch": {
- "summary": "Update an existing project card",
+ "summary": "Update an existing project column",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"projects-classic"
],
- "operationId": "projects-classic/update-card",
+ "operationId": "projects-classic/update-column",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column"
},
"parameters": [
{
- "name": "card_id",
- "description": "The unique identifier of the card.",
+ "name": "column_id",
+ "description": "The unique identifier of the column.",
"in": "path",
"required": true,
"schema": {
@@ -189791,30 +189133,27 @@
}
],
"requestBody": {
- "required": false,
+ "required": true,
"content": {
"application/json": {
"schema": {
- "type": "object",
"properties": {
- "note": {
- "description": "The project card's note",
- "example": "Update all gems",
- "type": "string",
- "nullable": true
- },
- "archived": {
- "description": "Whether or not the card is archived",
- "example": false,
- "type": "boolean"
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
}
- }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
},
"examples": {
"default": {
- "summary": "Change the note on the card",
+ "summary": "Rename the project column",
"value": {
- "note": "Add payload for delete Project column"
+ "name": "To Do"
}
}
}
@@ -189827,1027 +189166,43 @@
"content": {
"application/json": {
"schema": {
- "title": "Project Card",
- "description": "Project cards represent a scope of work.",
+ "title": "Project Column",
+ "description": "Project columns contain cards of work.",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/projects/columns/cards/1478"
+ "example": "https://api.github.com/projects/columns/367"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367/cards"
},
"id": {
- "description": "The project card's ID",
+ "description": "The unique identifier of the project column",
"example": 42,
- "type": "integer",
- "format": "int64"
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
- },
- "note": {
- "type": "string",
- "example": "Add payload for delete Project column",
- "nullable": true
+ "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2016-09-05T14:21:06Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:20:22Z"
- },
- "archived": {
- "description": "Whether or not the card is archived",
- "example": false,
- "type": "boolean"
- },
- "column_name": {
- "type": "string"
- },
- "project_id": {
- "type": "string"
- },
- "column_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "content_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
- }
- },
- "required": [
- "id",
- "node_id",
- "note",
- "url",
- "column_url",
- "project_url",
- "creator",
- "created_at",
- "updated_at"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "url": "https://api.github.com/projects/columns/cards/1478",
- "id": 1478,
- "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
- "note": "Add payload for delete Project column",
- "creator": {
- "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
- },
- "created_at": "2016-09-05T14:21:06Z",
- "updated_at": "2016-09-05T14:20:22Z",
- "archived": false,
- "column_url": "https://api.github.com/projects/columns/367",
- "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
- "project_url": "https://api.github.com/projects/120"
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error Simple",
- "description": "Validation Error Simple",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "cards",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a project card",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/delete-card",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card"
- },
- "parameters": [
- {
- "name": "card_id",
- "description": "The unique identifier of the card.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "cards",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- }
- },
- "/projects/columns/cards/{card_id}/moves": {
- "post": {
- "summary": "Move a project card",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/move-card",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card"
- },
- "parameters": [
- {
- "name": "card_id",
- "description": "The unique identifier of the card.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "position": {
- "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.",
- "example": "bottom",
- "type": "string",
- "pattern": "^(?:top|bottom|after:\\d+)$"
- },
- "column_id": {
- "description": "The unique identifier of the column the card should be moved to",
- "example": 42,
- "type": "integer"
- }
- },
- "required": [
- "position"
- ],
- "type": "object"
- },
- "examples": {
- "default": {
- "summary": "Move the card to the bottom of the column",
- "value": {
- "column_id": 42,
- "position": "bottom"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
- },
- "examples": {
- "default": {
- "value": null
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "503": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "cards",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- }
- },
- "/projects/columns/{column_id}": {
- "get": {
- "summary": "Get a project column",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/get-column",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column"
- },
- "parameters": [
- {
- "name": "column_id",
- "description": "The unique identifier of the column.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Project Column",
- "description": "Project columns contain cards of work.",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
- },
- "cards_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367/cards"
- },
- "id": {
- "description": "The unique identifier of the project column",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
- },
- "name": {
- "description": "Name of the project column",
- "example": "Remaining tasks",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:18:44Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:22:28Z"
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "project_url",
- "cards_url",
- "name",
- "created_at",
- "updated_at"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "url": "https://api.github.com/projects/columns/367",
- "project_url": "https://api.github.com/projects/120",
- "cards_url": "https://api.github.com/projects/columns/367/cards",
- "id": 367,
- "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
- "name": "To Do",
- "created_at": "2016-09-05T14:18:44Z",
- "updated_at": "2016-09-05T14:22:28Z"
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "columns",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update an existing project column",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/update-column",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column"
- },
- "parameters": [
- {
- "name": "column_id",
- "description": "The unique identifier of the column.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "name": {
- "description": "Name of the project column",
- "example": "Remaining tasks",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "examples": {
- "default": {
- "summary": "Rename the project column",
- "value": {
- "name": "To Do"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Project Column",
- "description": "Project columns contain cards of work.",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
- },
- "cards_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367/cards"
- },
- "id": {
- "description": "The unique identifier of the project column",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
- },
- "name": {
- "description": "Name of the project column",
- "example": "Remaining tasks",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:18:44Z"
+ "example": "2016-09-05T14:18:44Z"
},
"updated_at": {
"type": "string",
@@ -467378,1522 +465733,276 @@
"delete": {
"summary": "Remove an authorized SSH key",
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
- "operationId": "enterprise-admin/remove-authorized-ssh-key",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "pretty-print": {
- "type": "string"
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
- "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
- },
- {
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
- "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
- },
- {
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
- "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
- }
- ]
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/x-www-form-urlencoded": {
- "schema": {
- "type": "object",
- "properties": {
- "authorized_key": {
- "type": "string",
- "description": "The public SSH key."
- }
- },
- "required": [
- "authorized_key"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/setup/api/start": {
- "post": {
- "summary": "Create a GitHub license",
- "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
- "operationId": "enterprise-admin/create-enterprise-server-license",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#create-a-github-license"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "202": {
- "description": "Response"
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "license": {
- "type": "string",
- "description": "The content of your _.ghl_ license file."
- },
- "password": {
- "type": "string",
- "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter."
- },
- "settings": {
- "type": "string",
- "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings)."
- }
- },
- "required": [
- "license"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "license": "@enterprise.ghl",
- "password": "secret"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/setup/api/upgrade": {
- "post": {
- "summary": "Upgrade a license",
- "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
- "operationId": "enterprise-admin/upgrade-license",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#upgrade-a-license"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "202": {
- "description": "Response"
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": false,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "license": {
- "type": "string",
- "description": "The content of your new _.ghl_ license file."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "license": "@enterprise.ghl"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/teams/{team_id}": {
- "get": {
- "summary": "Get a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- },
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the team."
- },
- "description": {
- "type": "string",
- "description": "The description of the team."
- },
- "privacy": {
- "type": "string",
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
- "enum": [
- "secret",
- "closed"
- ]
- },
- "notification_setting": {
- "type": "string",
- "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ]
- },
- "permission": {
- "type": "string",
- "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
- "enum": [
- "pull",
- "push",
- "admin"
- ],
- "default": "pull"
- },
- "parent_team_id": {
- "type": "integer",
- "description": "The ID of a team to set as the parent team.",
- "nullable": true
- }
- },
- "required": [
- "name"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed",
- "notification_setting": "notifications_enabled"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response when the updated information already exists",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
+ "operationId": "enterprise-admin/remove-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
},
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
+ "pretty-print": {
+ "type": "string"
+ }
}
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
+ }
},
"examples": {
"default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
+ "value": [
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
},
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
- }
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ },
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ }
+ ]
}
}
}
}
},
- "201": {
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "The public SSH key."
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/start": {
+ "post": {
+ "summary": "Create a GitHub license",
+ "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
+ "operationId": "enterprise-admin/create-enterprise-server-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#create-a-github-license"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response"
+ },
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your _.ghl_ license file."
+ },
+ "password": {
+ "type": "string",
+ "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter."
+ },
+ "settings": {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings)."
+ }
+ },
+ "required": [
+ "license"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "license": "@enterprise.ghl",
+ "password": "secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/upgrade": {
+ "post": {
+ "summary": "Upgrade a license",
+ "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
+ "operationId": "enterprise-admin/upgrade-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#upgrade-a-license"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response"
+ },
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": false,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your new _.ghl_ license file."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "license": "@enterprise.ghl"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/teams/{team_id}": {
+ "get": {
+ "summary": "Get a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "description": "The unique identifier of the team.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
@@ -469479,233 +466588,6 @@
}
}
}
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
}
},
"x-github": {
@@ -469717,436 +466599,17 @@
"subcategory": "teams"
},
"deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
},
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "patch": {
+ "summary": "Update a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -470166,30 +466629,57 @@
"schema": {
"type": "object",
"properties": {
- "title": {
+ "name": {
"type": "string",
- "description": "The discussion post's title."
+ "description": "The name of the team."
},
- "body": {
+ "description": {
"type": "string",
- "description": "The discussion post's body text."
+ "description": "The description of the team."
},
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.",
+ "nullable": true
}
},
"required": [
- "title",
- "body"
+ "name"
]
},
"examples": {
"default": {
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
}
}
}
@@ -470197,1135 +466687,1248 @@
}
},
"responses": {
- "201": {
- "description": "Response",
+ "200": {
+ "description": "Response when the updated information already exists",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
- "example": 0
+ "example": 3
},
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
- "url": {
+ "login": {
"type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
+ "example": "github"
},
- "confused": {
- "type": "integer"
+ "id": {
+ "type": "integer",
+ "example": 1
},
- "heart": {
- "type": "integer"
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
- "hooray": {
- "type": "integer"
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "eyes": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "login": {
+ "issues_url": {
"type": "string",
- "example": "octocat"
+ "example": "https://api.github.com/orgs/github/issues"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "node_id": {
+ "public_members_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
"avatar_url": {
"type": "string",
- "format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "A great organization",
"nullable": true
},
- "url": {
+ "name": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "github"
},
- "html_url": {
+ "company": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "GitHub"
},
- "followers_url": {
+ "blog": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "https://github.com/blog"
},
- "following_url": {
+ "location": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "San Francisco"
},
- "gists_url": {
+ "email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "format": "email",
+ "example": "octocat@github.com"
},
- "starred_url": {
+ "twitter_username": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "github",
+ "nullable": true
},
- "subscriptions_url": {
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "https://github.com/octocat"
},
- "organizations_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
},
- "repos_url": {
+ "type": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "Organization"
},
- "events_url": {
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
},
- "received_events_url": {
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
},
- "type": {
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
"type": "string",
- "example": "User"
+ "example": "all"
},
- "site_admin": {
- "type": "boolean"
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
},
- "starred_at": {
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "date-time"
},
- "user_view_type": {
+ "archived_at": {
"type": "string",
- "example": "public"
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
+ "login",
+ "url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
"repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
"type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "team_url": {
+ "ldap_dn": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
},
- "updated_at": {
+ "type": {
+ "description": "The ownership type of the team",
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
+ "201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
- "example": 0
+ "example": 3
},
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
+ "login",
"url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
"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
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -471334,20 +467937,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-legacy",
+ "operationId": "teams/delete-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -471358,20 +467961,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -471380,22 +468069,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
+ "/teams/{team_id}/discussions": {
"get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List discussions (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-legacy",
+ "operationId": "teams/list-discussions-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy"
},
"parameters": [
{
@@ -471407,15 +468096,6 @@
"type": "integer"
}
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
{
"name": "direction",
"description": "The direction to sort the results by.",
@@ -471457,8 +468137,8 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -471587,13 +468267,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -471603,41 +468283,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -471696,10 +468391,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -471729,19 +468427,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -471774,20 +468475,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Create a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-legacy",
+ "operationId": "teams/create-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy"
},
"parameters": [
{
@@ -471798,15 +468499,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -471816,19 +468508,30 @@
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
}
},
"required": [
+ "title",
"body"
]
},
"examples": {
"default": {
"value": {
- "body": "Do you like apples?"
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
}
}
}
@@ -471841,8 +468544,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -471971,13 +468674,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -471987,41 +468690,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -472080,10 +468798,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -472111,19 +468832,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -472148,22 +468872,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/teams/{team_id}/discussions/{discussion_number}": {
"get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-legacy",
+ "operationId": "teams/get-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy"
},
"parameters": [
{
@@ -472183,15 +468907,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -472200,8 +468915,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -472330,13 +469045,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -472346,41 +469061,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -472439,10 +469169,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -472470,19 +469203,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -472506,20 +469242,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Update a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-legacy",
+ "operationId": "teams/update-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy"
},
"parameters": [
{
@@ -472539,37 +469275,29 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "body": "Do you like pineapples?"
+ "title": "Welcome to our first team post"
}
}
}
@@ -472582,8 +469310,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -472712,13 +469440,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -472728,41 +469456,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -472821,10 +469564,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -472852,19 +469598,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
"updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -472888,20 +469637,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-legacy",
+ "operationId": "teams/delete-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy"
},
"parameters": [
{
@@ -472921,15 +469670,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -472943,7 +469683,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
index 11b31b565..28833ddcb 100644
--- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
+++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
@@ -4479,7 +4479,7 @@ paths:
application/json:
schema: *24
application/scim+json:
- schema: &551
+ schema: &548
title: Scim Error
description: Scim Error
type: object
@@ -12365,7 +12365,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &382
+ instances_url: &379
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -12400,7 +12400,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &383
+ dismissed_reason: &380
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -12409,13 +12409,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &384
+ dismissed_comment: &381
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &385
+ rule: &382
type: object
properties:
id:
@@ -12454,7 +12454,7 @@ paths:
description: A set of tags applicable for the rule.
items:
type: string
- tool: &386
+ tool: &383
type: object
properties:
name: *90
@@ -12464,26 +12464,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *91
- most_recent_instance: &387
+ most_recent_instance: &384
type: object
properties:
- ref: &380
+ ref: &377
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &392
+ analysis_key: &389
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
this includes the workflow filename and job name.
- environment: &393
+ environment: &390
type: string
description: Identifies the variable values associated with
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &394
+ category: &391
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -12497,7 +12497,7 @@ paths:
properties:
text:
type: string
- location: &395
+ location: &392
type: object
description: Describe a region within a file for the alert.
properties:
@@ -12518,7 +12518,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &396
+ items: &393
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -13300,7 +13300,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
- - &418
+ - &415
name: has
in: query
description: |-
@@ -13423,7 +13423,7 @@ paths:
enum:
- development
- runtime
- security_advisory: &419
+ security_advisory: &416
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -13654,14 +13654,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *102
- auto_dismissed_at: &420
+ auto_dismissed_at: &417
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &421
+ dismissal_request: &418
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -14137,14 +14137,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &542
+ state: &539
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: &543
+ resolution: &540
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -14730,7 +14730,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &466
+ properties: &463
id:
type: integer
format: int64
@@ -14993,7 +14993,7 @@ paths:
timeline_url:
type: string
format: uri
- type: &578
+ type: &575
title: Issue Type
description: The type of issue.
type: object
@@ -15107,7 +15107,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &575
+ sub_issues_summary: &572
title: Sub-issues Summary
type: object
properties:
@@ -15127,7 +15127,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &576
+ issue_dependencies_summary: &573
title: Issue Dependencies Summary
type: object
properties:
@@ -15146,7 +15146,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &577
+ items: &574
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -15207,7 +15207,7 @@ paths:
- node_id
- data_type
- value
- required: &467
+ required: &464
- assignee
- closed_at
- comments
@@ -15291,7 +15291,7 @@ paths:
action:
type: string
issue: *109
- comment: &462
+ comment: &459
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -15950,7 +15950,7 @@ paths:
- review_comment
- self
author_association: *110
- auto_merge: &410
+ auto_merge: &407
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -16414,7 +16414,7 @@ paths:
type: string
release:
allOf:
- - &520
+ - &517
title: Release
description: A release.
type: object
@@ -16485,7 +16485,7 @@ paths:
author: *19
assets:
type: array
- items: &521
+ items: &518
title: Release Asset
description: Data related to a release.
type: object
@@ -17065,7 +17065,7 @@ paths:
url:
type: string
format: uri
- user: &593
+ user: &588
title: Public User
description: Public User
type: object
@@ -21685,14 +21685,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &302
+ - &299
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &303
+ - &300
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -21764,7 +21764,7 @@ paths:
'404': *26
'403': *43
'304': *42
- '301': &314
+ '301': &311
description: Moved permanently
content:
application/json:
@@ -21786,7 +21786,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &494
+ - &491
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -21794,7 +21794,7 @@ paths:
schema:
type: boolean
default: false
- - &495
+ - &492
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -21804,7 +21804,7 @@ paths:
type: boolean
default: false
- *119
- - &496
+ - &493
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:
@@ -22248,7 +22248,7 @@ paths:
- url
- subscription_url
examples:
- default: &497
+ default: &494
value:
- id: '1'
repository:
@@ -22794,7 +22794,7 @@ paths:
type: array
items: *70
examples:
- default: &602
+ default: &597
value:
- login: github
id: 1
@@ -23685,7 +23685,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &319
+ items: &316
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -23936,7 +23936,7 @@ paths:
type: array
items: *84
examples:
- default: &599
+ default: &594
value:
total_count: 1
repositories:
@@ -25737,7 +25737,7 @@ paths:
description: Response
content:
application/json:
- schema: &341
+ schema: &338
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -25766,7 +25766,7 @@ paths:
- key_id
- key
examples:
- default: &342
+ default: &339
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -26179,7 +26179,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-organization-variables
parameters:
- *140
- - &326
+ - &323
name: per_page
description: The number of results per page (max 30). For more information,
see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -26828,7 +26828,7 @@ paths:
be returned.
in: query
required: false
- schema: &381
+ schema: &378
type: string
description: Severity of a code scanning alert.
enum:
@@ -27370,7 +27370,7 @@ paths:
description: Response
content:
application/json:
- schema: &424
+ schema: &421
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -27387,7 +27387,7 @@ paths:
- key_id
- key
examples:
- default: &425
+ default: &422
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -27985,7 +27985,7 @@ paths:
description: Response
content:
application/json:
- schema: &297
+ schema: &294
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -28066,7 +28066,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &298
+ default: &295
value:
group_id: '123'
group_name: Octocat admins
@@ -28121,7 +28121,7 @@ paths:
description: Response
content:
application/json:
- schema: &295
+ schema: &292
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -28158,7 +28158,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &296
+ default: &293
value:
groups:
- group_id: '123'
@@ -28794,7 +28794,7 @@ paths:
application/json:
schema: *39
examples:
- default: &459
+ default: &456
value:
id: 1
account:
@@ -31482,7 +31482,7 @@ paths:
- nuget
- container
- *140
- - &603
+ - &598
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -31523,7 +31523,7 @@ paths:
default: *225
'403': *43
'401': *41
- '400': &605
+ '400': &600
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -33976,7 +33976,7 @@ paths:
description: Response
content:
application/json:
- schema: &313
+ schema: &310
title: Full Repository
description: Full Repository
type: object
@@ -34474,7 +34474,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &315
+ default: &312
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -35046,7 +35046,7 @@ paths:
- *140
- *4
- *5
- - &528
+ - &525
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -35320,7 +35320,7 @@ paths:
- repository_property
rules:
type: array
- items: &529
+ items: &526
title: Repository Rule
type: object
description: A repository rule.
@@ -36066,7 +36066,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *140
- - &530
+ - &527
name: ref
description: The name of the ref. Cannot contain wildcard characters. When
specified, only rule evaluations triggered for this ref will be returned.
@@ -36079,7 +36079,7 @@ paths:
in: query
schema:
type: string
- - &531
+ - &528
name: time_period
description: |-
The time period to filter by.
@@ -36095,14 +36095,14 @@ paths:
- week
- month
default: day
- - &532
+ - &529
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
- - &533
+ - &530
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -36122,7 +36122,7 @@ paths:
description: Response
content:
application/json:
- schema: &534
+ schema: &531
title: Rule Suites
description: Response
type: array
@@ -36176,7 +36176,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &535
+ default: &532
value:
- id: 21
actor_id: 12
@@ -36220,7 +36220,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *140
- - &536
+ - &533
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -36236,7 +36236,7 @@ paths:
description: Response
content:
application/json:
- schema: &537
+ schema: &534
title: Rule Suite
description: Response
type: object
@@ -36334,7 +36334,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &538
+ default: &535
value:
id: 21
actor_id: 12
@@ -36552,7 +36552,7 @@ paths:
- *9
- *5
- *4
- - &540
+ - &537
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -36562,7 +36562,7 @@ paths:
required: false
schema:
type: string
- - &541
+ - &538
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -36734,7 +36734,7 @@ paths:
application/json:
schema:
type: array
- items: &304
+ items: &301
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -37519,13 +37519,6 @@ paths:
does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -37577,8 +37570,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -37591,7 +37582,7 @@ paths:
- updated_at
- url
examples:
- default: &583
+ default: &580
value:
- author:
login: octocat
@@ -37616,8 +37607,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -37727,8 +37716,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -37839,7 +37826,7 @@ paths:
application/json:
schema: *289
examples:
- default: &584
+ default: &581
value:
author:
login: octocat
@@ -37864,8 +37851,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -37920,410 +37905,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - *140
- - *219
- - *291
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &292
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *17
- required: *18
- nullable: true
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *111
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &585
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- headers:
- Link: *6
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: &293
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- - &294
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *293
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- - *294
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: &586
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- - *294
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -38345,9 +37926,9 @@ paths:
description: Response
content:
application/json:
- schema: *295
+ schema: *292
examples:
- default: *296
+ default: *293
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -38390,9 +37971,9 @@ paths:
description: Response
content:
application/json:
- schema: *297
+ schema: *294
examples:
- default: *298
+ default: *295
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -38497,7 +38078,7 @@ paths:
description: Response
content:
application/json:
- schema: &299
+ schema: &296
title: Team Membership
description: Team Membership
type: object
@@ -38524,7 +38105,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &587
+ response-if-user-is-a-team-maintainer: &582
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -38587,9 +38168,9 @@ paths:
description: Response
content:
application/json:
- schema: *299
+ schema: *296
examples:
- response-if-users-membership-with-team-is-now-pending: &588
+ response-if-users-membership-with-team-is-now-pending: &583
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -38662,7 +38243,7 @@ paths:
application/json:
schema:
type: array
- items: &300
+ items: &297
title: Team Project
description: A team's access to a project.
type: object
@@ -38730,7 +38311,7 @@ paths:
- updated_at
- permissions
examples:
- default: &589
+ default: &584
value:
- owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -38795,7 +38376,7 @@ paths:
parameters:
- *140
- *219
- - &301
+ - &298
name: project_id
description: The unique identifier of the project.
in: path
@@ -38807,9 +38388,9 @@ paths:
description: Response
content:
application/json:
- schema: *300
+ schema: *297
examples:
- default: &590
+ default: &585
value:
owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -38873,7 +38454,7 @@ paths:
parameters:
- *140
- *219
- - *301
+ - *298
requestBody:
required: false
content:
@@ -38941,7 +38522,7 @@ paths:
parameters:
- *140
- *219
- - *301
+ - *298
responses:
'204':
description: Response
@@ -39012,14 +38593,14 @@ paths:
parameters:
- *140
- *219
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &591
+ schema: &586
title: Team Repository
description: A team's access to a repository.
type: object
@@ -39590,8 +39171,8 @@ paths:
parameters:
- *140
- *219
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -39638,8 +39219,8 @@ paths:
parameters:
- *140
- *219
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -39674,9 +39255,9 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
- response-if-child-teams-exist: &592
+ response-if-child-teams-exist: &587
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -39803,7 +39384,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card
parameters:
- - &305
+ - &302
name: card_id
description: The unique identifier of the card.
in: path
@@ -39815,7 +39396,7 @@ paths:
description: Response
content:
application/json:
- schema: &306
+ schema: &303
title: Project Card
description: Project cards represent a scope of work.
type: object
@@ -39882,7 +39463,7 @@ paths:
- created_at
- updated_at
examples:
- default: &307
+ default: &304
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
@@ -39938,7 +39519,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card
parameters:
- - *305
+ - *302
requestBody:
required: false
content:
@@ -39965,9 +39546,9 @@ paths:
description: Response
content:
application/json:
- schema: *306
+ schema: *303
examples:
- default: *307
+ default: *304
'304': *42
'403': *43
'401': *41
@@ -39994,7 +39575,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card
parameters:
- - *305
+ - *302
responses:
'204':
description: Response
@@ -40038,7 +39619,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card
parameters:
- - *305
+ - *302
requestBody:
required: true
content:
@@ -40149,7 +39730,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column
parameters:
- - &308
+ - &305
name: column_id
description: The unique identifier of the column.
in: path
@@ -40161,7 +39742,7 @@ paths:
description: Response
content:
application/json:
- schema: &309
+ schema: &306
title: Project Column
description: Project columns contain cards of work.
type: object
@@ -40207,7 +39788,7 @@ paths:
- created_at
- updated_at
examples:
- default: &310
+ default: &307
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
@@ -40242,7 +39823,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column
parameters:
- - *308
+ - *305
requestBody:
required: true
content:
@@ -40266,9 +39847,9 @@ paths:
description: Response
content:
application/json:
- schema: *309
+ schema: *306
examples:
- default: *310
+ default: *307
'304': *42
'403': *43
'401': *41
@@ -40293,7 +39874,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column
parameters:
- - *308
+ - *305
responses:
'204':
description: Response
@@ -40322,7 +39903,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#list-project-cards
parameters:
- - *308
+ - *305
- name: archived_state
description: Filters the project cards that are returned by the card's state.
in: query
@@ -40343,7 +39924,7 @@ paths:
application/json:
schema:
type: array
- items: *306
+ items: *303
examples:
default:
value:
@@ -40402,7 +39983,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#create-a-project-card
parameters:
- - *308
+ - *305
requestBody:
required: true
content:
@@ -40442,9 +40023,9 @@ paths:
description: Response
content:
application/json:
- schema: *306
+ schema: *303
examples:
- default: *307
+ default: *304
'304': *42
'403': *43
'401': *41
@@ -40500,7 +40081,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#move-a-project-column
parameters:
- - *308
+ - *305
requestBody:
required: true
content:
@@ -40559,7 +40140,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#get-a-project
parameters:
- - *301
+ - *298
responses:
'200':
description: Response
@@ -40567,7 +40148,7 @@ paths:
application/json:
schema: *242
examples:
- default: &311
+ default: &308
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
@@ -40621,7 +40202,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#update-a-project
parameters:
- - *301
+ - *298
requestBody:
required: false
content:
@@ -40669,7 +40250,7 @@ paths:
application/json:
schema: *242
examples:
- default: *311
+ default: *308
'404':
description: Not Found if the authenticated user does not have access to
the project
@@ -40709,7 +40290,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#delete-a-project
parameters:
- - *301
+ - *298
responses:
'204':
description: Delete Success
@@ -40752,7 +40333,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#list-project-collaborators
parameters:
- - *301
+ - *298
- 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
@@ -40809,7 +40390,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#add-project-collaborator
parameters:
- - *301
+ - *298
- *8
requestBody:
required: false
@@ -40862,7 +40443,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#remove-user-as-a-collaborator
parameters:
- - *301
+ - *298
- *8
responses:
'204':
@@ -40894,7 +40475,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#get-project-permission-for-a-user
parameters:
- - *301
+ - *298
- *8
responses:
'200':
@@ -40968,7 +40549,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#list-project-columns
parameters:
- - *301
+ - *298
- *4
- *5
responses:
@@ -40978,7 +40559,7 @@ paths:
application/json:
schema:
type: array
- items: *309
+ items: *306
examples:
default:
value:
@@ -41016,7 +40597,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#create-a-project-column
parameters:
- - *301
+ - *298
requestBody:
required: true
content:
@@ -41039,7 +40620,7 @@ paths:
description: Response
content:
application/json:
- schema: *309
+ schema: *306
examples:
default:
value:
@@ -41104,7 +40685,7 @@ paths:
resources:
type: object
properties:
- core: &312
+ core: &309
title: Rate Limit
type: object
properties:
@@ -41121,20 +40702,20 @@ paths:
- remaining
- reset
- used
- graphql: *312
- search: *312
- code_search: *312
- source_import: *312
- integration_manifest: *312
- code_scanning_upload: *312
- actions_runner_registration: *312
- scim: *312
- dependency_sbom: *312
- code_scanning_autofix: *312
+ graphql: *309
+ search: *309
+ code_search: *309
+ source_import: *309
+ integration_manifest: *309
+ code_scanning_upload: *309
+ actions_runner_registration: *309
+ scim: *309
+ dependency_sbom: *309
+ code_scanning_autofix: *309
required:
- core
- search
- rate: *312
+ rate: *309
required:
- rate
- resources
@@ -41239,14 +40820,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
default-response:
summary: Default response
@@ -41745,7 +41326,7 @@ paths:
status: disabled
'403': *43
'404': *26
- '301': *314
+ '301': *311
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -41763,8 +41344,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#update-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -41980,10 +41561,10 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
- '307': &316
+ default: *312
+ '307': &313
description: Temporary Redirect
content:
application/json:
@@ -42028,8 +41609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -42051,7 +41632,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
- '307': *316
+ '307': *313
'404': *26
'409': *145
x-github:
@@ -42075,11 +41656,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- - &333
+ - &330
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -42102,7 +41683,7 @@ paths:
type: integer
artifacts:
type: array
- items: &317
+ items: &314
title: Artifact
description: An artifact
type: object
@@ -42173,7 +41754,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &334
+ default: &331
value:
total_count: 2
artifacts:
@@ -42232,9 +41813,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#get-an-artifact
parameters:
- - *302
- - *303
- - &318
+ - *299
+ - *300
+ - &315
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -42246,7 +41827,7 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
default:
value:
@@ -42283,9 +41864,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#delete-an-artifact
parameters:
- - *302
- - *303
- - *318
+ - *299
+ - *300
+ - *315
responses:
'204':
description: Response
@@ -42309,9 +41890,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#download-an-artifact
parameters:
- - *302
- - *303
- - *318
+ - *299
+ - *300
+ - *315
- name: archive_format
in: path
required: true
@@ -42348,14 +41929,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *319
+ schema: *316
examples:
default:
value:
@@ -42381,14 +41962,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: &320
+ schema: &317
title: Actions cache usage policy for repository
description: GitHub Actions cache usage policy for repository.
type: object
@@ -42400,7 +41981,7 @@ paths:
required:
- repo_cache_size_limit_in_gb
examples:
- default: &321
+ default: &318
value:
repo_cache_size_limit_in_gb: 14
x-github:
@@ -42421,8 +42002,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -42430,9 +42011,9 @@ paths:
required: true
content:
application/json:
- schema: *320
+ schema: *317
examples:
- selected_actions: *321
+ selected_actions: *318
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42452,11 +42033,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- - &322
+ - &319
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/`. To reference
@@ -42490,7 +42071,7 @@ paths:
description: Response
content:
application/json:
- schema: &323
+ schema: &320
title: Repository actions caches
description: Repository actions caches
type: object
@@ -42532,7 +42113,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &324
+ default: &321
value:
total_count: 1
actions_caches:
@@ -42564,23 +42145,23 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *322
+ - *319
responses:
'200':
description: Response
content:
application/json:
- schema: *323
+ schema: *320
examples:
- default: *324
+ default: *321
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42600,8 +42181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -42632,9 +42213,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *302
- - *303
- - &325
+ - *299
+ - *300
+ - &322
name: job_id
description: The unique identifier of the job.
in: path
@@ -42646,7 +42227,7 @@ paths:
description: Response
content:
application/json:
- schema: &337
+ schema: &334
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -42953,9 +42534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *302
- - *303
- - *325
+ - *299
+ - *300
+ - *322
responses:
'302':
description: Response
@@ -42983,9 +42564,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *302
- - *303
- - *325
+ - *299
+ - *300
+ - *322
requestBody:
required: false
content:
@@ -43030,8 +42611,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Status response
@@ -43081,8 +42662,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -43145,8 +42726,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -43164,7 +42745,7 @@ paths:
type: integer
secrets:
type: array
- items: &339
+ items: &336
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -43184,7 +42765,7 @@ paths:
- created_at
- updated_at
examples:
- default: &340
+ default: &337
value:
total_count: 2
secrets:
@@ -43217,9 +42798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-organization-variables
parameters:
- - *302
- - *303
- - *326
+ - *299
+ - *300
+ - *323
- *5
responses:
'200':
@@ -43236,7 +42817,7 @@ paths:
type: integer
variables:
type: array
- items: &343
+ items: &340
title: Actions Variable
type: object
properties:
@@ -43266,7 +42847,7 @@ paths:
- created_at
- updated_at
examples:
- default: &344
+ default: &341
value:
total_count: 2
variables:
@@ -43299,8 +42880,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43309,7 +42890,7 @@ paths:
schema:
type: object
properties:
- enabled: &327
+ enabled: &324
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *69
@@ -43342,8 +42923,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -43354,7 +42935,7 @@ paths:
schema:
type: object
properties:
- enabled: *327
+ enabled: *324
allowed_actions: *69
required:
- enabled
@@ -43385,14 +42966,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: &328
+ schema: &325
type: object
properties:
access_level:
@@ -43410,7 +42991,7 @@ paths:
required:
- access_level
examples:
- default: &329
+ default: &326
value:
access_level: organization
x-github:
@@ -43435,15 +43016,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
application/json:
- schema: *328
+ schema: *325
examples:
- default: *329
+ default: *326
responses:
'204':
description: Response
@@ -43467,8 +43048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43499,8 +43080,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -43532,8 +43113,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43562,8 +43143,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Success response
@@ -43603,8 +43184,8 @@ paths:
in: query
schema:
type: string
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -43648,8 +43229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43681,8 +43262,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -43756,8 +43337,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'201':
description: Response
@@ -43793,8 +43374,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'201':
description: Response
@@ -43824,8 +43405,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'200':
@@ -43855,8 +43436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'204':
@@ -43883,8 +43464,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'200': *87
@@ -43909,8 +43490,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
requestBody:
required: true
@@ -43959,8 +43540,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
requestBody:
required: true
@@ -44010,8 +43591,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'200': *165
@@ -44041,8 +43622,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
- *166
responses:
@@ -44072,9 +43653,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *302
- - *303
- - &347
+ - *299
+ - *300
+ - &344
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.
@@ -44082,7 +43663,7 @@ paths:
required: false
schema:
type: string
- - &348
+ - &345
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -44090,7 +43671,7 @@ paths:
required: false
schema:
type: string
- - &349
+ - &346
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -44099,7 +43680,7 @@ paths:
required: false
schema:
type: string
- - &350
+ - &347
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
@@ -44126,7 +43707,7 @@ paths:
- pending
- *4
- *5
- - &351
+ - &348
name: created
description: Returns workflow runs created within the given date-time range.
For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -44135,7 +43716,7 @@ paths:
schema:
type: string
format: date-time
- - &330
+ - &327
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -44144,13 +43725,13 @@ paths:
schema:
type: boolean
default: false
- - &352
+ - &349
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &353
+ - &350
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -44173,7 +43754,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &331
+ items: &328
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -44268,7 +43849,7 @@ paths:
that triggered the run.
type: array
nullable: true
- items: &371
+ items: &368
title: Pull Request Minimal
type: object
properties:
@@ -44387,7 +43968,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &375
+ properties: &372
id:
type: string
description: SHA for the commit
@@ -44438,7 +44019,7 @@ paths:
- name
- email
nullable: true
- required: &376
+ required: &373
- id
- tree_id
- message
@@ -44485,7 +44066,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &354
+ default: &351
value:
total_count: 1
workflow_runs:
@@ -44721,24 +44302,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *302
- - *303
- - &332
+ - *299
+ - *300
+ - &329
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *330
+ - *327
responses:
'200':
description: Response
content:
application/json:
- schema: *331
+ schema: *328
examples:
- default: &335
+ default: &332
value:
id: 30433642
name: Build
@@ -44979,9 +44560,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'204':
description: Response
@@ -45004,9 +44585,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'200':
description: Response
@@ -45127,12 +44708,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
- *4
- *5
- - *333
+ - *330
responses:
'200':
description: Response
@@ -45148,9 +44729,9 @@ paths:
type: integer
artifacts:
type: array
- items: *317
+ items: *314
examples:
- default: *334
+ default: *331
headers:
Link: *6
x-github:
@@ -45174,25 +44755,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *302
- - *303
- - *332
- - &336
+ - *299
+ - *300
+ - *329
+ - &333
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *330
+ - *327
responses:
'200':
description: Response
content:
application/json:
- schema: *331
+ schema: *328
examples:
- default: *335
+ default: *332
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -45215,10 +44796,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *302
- - *303
- - *332
- - *336
+ - *299
+ - *300
+ - *329
+ - *333
- *4
- *5
responses:
@@ -45236,9 +44817,9 @@ paths:
type: integer
jobs:
type: array
- items: *337
+ items: *334
examples:
- default: &338
+ default: &335
value:
total_count: 1
jobs:
@@ -45351,10 +44932,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *302
- - *303
- - *332
- - *336
+ - *299
+ - *300
+ - *329
+ - *333
responses:
'302':
description: Response
@@ -45382,9 +44963,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'202':
description: Response
@@ -45417,9 +44998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: true
content:
@@ -45486,9 +45067,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'202':
description: Response
@@ -45521,9 +45102,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
- 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
@@ -45553,9 +45134,9 @@ paths:
type: integer
jobs:
type: array
- items: *337
+ items: *334
examples:
- default: *338
+ default: *335
headers:
Link: *6
x-github:
@@ -45580,9 +45161,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'302':
description: Response
@@ -45609,9 +45190,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'204':
description: Response
@@ -45638,9 +45219,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'200':
description: Response
@@ -45700,7 +45281,7 @@ paths:
items:
type: object
properties:
- type: &433
+ type: &430
type: string
description: The type of reviewer.
enum:
@@ -45710,7 +45291,7 @@ paths:
reviewer:
anyOf:
- *19
- - *304
+ - *301
required:
- environment
- wait_timer
@@ -45785,9 +45366,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: true
content:
@@ -45834,7 +45415,7 @@ paths:
application/json:
schema:
type: array
- items: &428
+ items: &425
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -45940,7 +45521,7 @@ paths:
- created_at
- updated_at
examples:
- default: &429
+ default: &426
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -45996,9 +45577,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: false
content:
@@ -46042,9 +45623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: false
content:
@@ -46091,8 +45672,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-secrets
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -46110,9 +45691,9 @@ paths:
type: integer
secrets:
type: array
- items: *339
+ items: *336
examples:
- default: *340
+ default: *337
headers:
Link: *6
x-github:
@@ -46137,16 +45718,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *341
+ schema: *338
examples:
- default: *342
+ default: *339
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46168,17 +45749,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *339
+ schema: *336
examples:
- default: &446
+ default: &443
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -46204,8 +45785,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
requestBody:
required: true
@@ -46263,8 +45844,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'204':
@@ -46290,9 +45871,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-variables
parameters:
- - *302
- - *303
- - *326
+ - *299
+ - *300
+ - *323
- *5
responses:
'200':
@@ -46309,9 +45890,9 @@ paths:
type: integer
variables:
type: array
- items: *343
+ items: *340
examples:
- default: *344
+ default: *341
headers:
Link: *6
x-github:
@@ -46334,8 +45915,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -46387,17 +45968,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: &447
+ default: &444
value:
name: USERNAME
value: octocat
@@ -46423,8 +46004,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
requestBody:
required: true
@@ -46467,8 +46048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
responses:
'204':
@@ -46494,8 +46075,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#list-repository-workflows
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -46513,7 +46094,7 @@ paths:
type: integer
workflows:
type: array
- items: &345
+ items: &342
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -46620,9 +46201,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#get-a-workflow
parameters:
- - *302
- - *303
- - &346
+ - *299
+ - *300
+ - &343
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -46637,7 +46218,7 @@ paths:
description: Response
content:
application/json:
- schema: *345
+ schema: *342
examples:
default:
value:
@@ -46670,9 +46251,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#disable-a-workflow
parameters:
- - *302
- - *303
- - *346
+ - *299
+ - *300
+ - *343
responses:
'204':
description: Response
@@ -46697,9 +46278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *302
- - *303
- - *346
+ - *299
+ - *300
+ - *343
responses:
'204':
description: Response
@@ -46750,9 +46331,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#enable-a-workflow
parameters:
- - *302
- - *303
- - *346
+ - *299
+ - *300
+ - *343
responses:
'204':
description: Response
@@ -46779,19 +46360,19 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *302
- - *303
+ - *299
+ - *300
+ - *343
+ - *344
+ - *345
- *346
- *347
+ - *4
+ - *5
- *348
+ - *327
- *349
- *350
- - *4
- - *5
- - *351
- - *330
- - *352
- - *353
responses:
'200':
description: Response
@@ -46807,9 +46388,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *331
+ items: *328
examples:
- default: *354
+ default: *351
headers:
Link: *6
x-github:
@@ -46832,8 +46413,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-activities
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *9
- *4
- *88
@@ -46997,8 +46578,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#list-assignees
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -47035,8 +46616,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: assignee
in: path
required: true
@@ -47070,8 +46651,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -47079,7 +46660,7 @@ paths:
application/json:
schema:
type: array
- items: &355
+ items: &352
title: Autolink reference
description: An autolink reference.
type: object
@@ -47133,8 +46714,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -47173,9 +46754,9 @@ paths:
description: response
content:
application/json:
- schema: *355
+ schema: *352
examples:
- default: &356
+ default: &353
value:
id: 1
key_prefix: TICKET-
@@ -47206,9 +46787,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *302
- - *303
- - &357
+ - *299
+ - *300
+ - &354
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -47220,9 +46801,9 @@ paths:
description: Response
content:
application/json:
- schema: *355
+ schema: *352
examples:
- default: *356
+ default: *353
'404': *26
x-github:
githubCloudOnly: false
@@ -47242,9 +46823,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *302
- - *303
- - *357
+ - *299
+ - *300
+ - *354
responses:
'204':
description: Response
@@ -47268,8 +46849,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response if Dependabot is enabled
@@ -47316,8 +46897,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#list-branches
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -47355,7 +46936,7 @@ paths:
- url
protected:
type: boolean
- protection: &359
+ protection: &356
title: Branch Protection
description: Branch Protection
type: object
@@ -47397,7 +46978,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &362
+ enforce_admins: &359
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -47412,7 +46993,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &364
+ required_pull_request_reviews: &361
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -47433,7 +47014,7 @@ paths:
description: The list of teams with review dismissal
access.
type: array
- items: *304
+ items: *301
apps:
description: The list of apps with review dismissal
access.
@@ -47462,7 +47043,7 @@ paths:
description: The list of teams allowed to bypass
pull request requirements.
type: array
- items: *304
+ items: *301
apps:
description: The list of apps allowed to bypass
pull request requirements.
@@ -47488,7 +47069,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &361
+ restrictions: &358
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -47551,7 +47132,7 @@ paths:
type: string
teams:
type: array
- items: *304
+ items: *301
apps:
type: array
items:
@@ -47765,9 +47346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#get-a-branch
parameters:
- - *302
- - *303
- - &360
+ - *299
+ - *300
+ - &357
name: branch
description: The name of the branch. Cannot contain wildcard characters. To
use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.14/graphql).
@@ -47781,14 +47362,14 @@ paths:
description: Response
content:
application/json:
- schema: &370
+ schema: &367
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &406
+ commit: &403
title: Commit
description: Commit
type: object
@@ -47822,7 +47403,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &358
+ properties: &355
name:
type: string
example: '"Chris Wanstrath"'
@@ -47838,7 +47419,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *358
+ properties: *355
nullable: true
message:
type: string
@@ -47859,7 +47440,7 @@ paths:
required:
- sha
- url
- verification: &453
+ verification: &450
title: Verification
type: object
properties:
@@ -47925,7 +47506,7 @@ paths:
type: integer
files:
type: array
- items: &415
+ items: &412
title: Diff Entry
description: Diff Entry
type: object
@@ -48009,7 +47590,7 @@ paths:
- self
protected:
type: boolean
- protection: *359
+ protection: *356
protection_url:
type: string
format: uri
@@ -48113,7 +47694,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *314
+ '301': *311
'404': *26
x-github:
githubCloudOnly: false
@@ -48135,15 +47716,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
default:
value:
@@ -48337,9 +47918,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -48594,7 +48175,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &367
+ required_status_checks: &364
title: Status Check Policy
description: Status Check Policy
type: object
@@ -48670,7 +48251,7 @@ paths:
items: *19
teams:
type: array
- items: *304
+ items: *301
apps:
type: array
items: *25
@@ -48688,7 +48269,7 @@ paths:
items: *19
teams:
type: array
- items: *304
+ items: *301
apps:
type: array
items: *25
@@ -48746,7 +48327,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *361
+ restrictions: *358
required_conversation_resolution:
type: object
properties:
@@ -48858,9 +48439,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -48885,17 +48466,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: &363
+ default: &360
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -48917,17 +48498,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: *363
+ default: *360
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -48946,9 +48527,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -48973,17 +48554,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: &365
+ default: &362
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -49079,9 +48660,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49179,9 +48760,9 @@ paths:
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *365
+ default: *362
'422': *35
x-github:
githubCloudOnly: false
@@ -49202,9 +48783,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49231,17 +48812,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: &366
+ default: &363
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -49264,17 +48845,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: *366
+ default: *363
'404': *26
x-github:
githubCloudOnly: false
@@ -49294,9 +48875,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49321,17 +48902,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: &368
+ default: &365
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -49357,9 +48938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49411,9 +48992,9 @@ paths:
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: *368
+ default: *365
'404': *26
'422': *35
x-github:
@@ -49435,9 +49016,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49461,9 +49042,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -49497,9 +49078,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49566,9 +49147,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49632,9 +49213,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
content:
application/json:
@@ -49700,15 +49281,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
default:
value:
@@ -49799,9 +49380,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49824,9 +49405,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -49836,7 +49417,7 @@ paths:
type: array
items: *25
examples:
- default: &369
+ default: &366
value:
- id: 1
slug: octoapp
@@ -49893,9 +49474,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -49929,7 +49510,7 @@ paths:
type: array
items: *25
examples:
- default: *369
+ default: *366
'422': *35
x-github:
githubCloudOnly: false
@@ -49950,9 +49531,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -49986,7 +49567,7 @@ paths:
type: array
items: *25
examples:
- default: *369
+ default: *366
'422': *35
x-github:
githubCloudOnly: false
@@ -50007,9 +49588,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50043,7 +49624,7 @@ paths:
type: array
items: *25
examples:
- default: *369
+ default: *366
'422': *35
x-github:
githubCloudOnly: false
@@ -50065,9 +49646,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -50075,7 +49656,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'404': *26
@@ -50097,9 +49678,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -50135,7 +49716,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'422': *35
@@ -50158,9 +49739,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -50196,7 +49777,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'422': *35
@@ -50219,9 +49800,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
content:
application/json:
@@ -50256,7 +49837,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'422': *35
@@ -50280,9 +49861,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -50316,9 +49897,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50376,9 +49957,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50436,9 +50017,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50498,9 +50079,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#rename-a-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50522,7 +50103,7 @@ paths:
description: Response
content:
application/json:
- schema: *370
+ schema: *367
examples:
default:
value:
@@ -50635,8 +50216,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#create-a-check-run
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -50915,7 +50496,7 @@ paths:
description: Response
content:
application/json:
- schema: &372
+ schema: &369
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -51034,8 +50615,8 @@ paths:
do not necessarily indicate pull requests that triggered the
check.
type: array
- items: *371
- deployment: &628
+ items: *368
+ deployment: &623
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -51315,9 +50896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#get-a-check-run
parameters:
- - *302
- - *303
- - &373
+ - *299
+ - *300
+ - &370
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -51329,9 +50910,9 @@ paths:
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: &374
+ default: &371
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -51431,9 +51012,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run
parameters:
- - *302
- - *303
- - *373
+ - *299
+ - *300
+ - *370
requestBody:
required: true
content:
@@ -51673,9 +51254,9 @@ paths:
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: *374
+ default: *371
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51695,9 +51276,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-run-annotations
parameters:
- - *302
- - *303
- - *373
+ - *299
+ - *300
+ - *370
- *4
- *5
responses:
@@ -51792,9 +51373,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#rerequest-a-check-run
parameters:
- - *302
- - *303
- - *373
+ - *299
+ - *300
+ - *370
responses:
'201':
description: Response
@@ -51838,8 +51419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -51861,7 +51442,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &377
+ schema: &374
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -51925,7 +51506,7 @@ paths:
nullable: true
pull_requests:
type: array
- items: *371
+ items: *368
nullable: true
app:
title: GitHub app
@@ -51951,8 +51532,8 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: *375
- required: *376
+ properties: *372
+ required: *373
latest_check_runs_count:
type: integer
check_runs_url:
@@ -51980,7 +51561,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &378
+ default: &375
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -52271,9 +51852,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52292,8 +51873,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -52602,9 +52183,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite
parameters:
- - *302
- - *303
- - &379
+ - *299
+ - *300
+ - &376
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -52616,9 +52197,9 @@ paths:
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52641,17 +52222,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *302
- - *303
- - *379
- - &412
+ - *299
+ - *300
+ - *376
+ - &409
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &413
+ - &410
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -52690,9 +52271,9 @@ paths:
type: integer
check_runs:
type: array
- items: *372
+ items: *369
examples:
- default: &414
+ default: &411
value:
total_count: 1
check_runs:
@@ -52794,9 +52375,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *302
- - *303
- - *379
+ - *299
+ - *300
+ - *376
responses:
'201':
description: Response
@@ -52829,20 +52410,20 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *183
- *184
- *5
- *4
- - &391
+ - &388
name: ref
description: The Git reference for the results you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
in: query
required: false
- schema: *380
+ schema: *377
- *9
- name: sort
description: The property by which to sort the results.
@@ -52865,7 +52446,7 @@ paths:
be returned.
in: query
required: false
- schema: *381
+ schema: *378
responses:
'200':
description: Response
@@ -52881,7 +52462,7 @@ paths:
updated_at: *100
url: *97
html_url: *98
- instances_url: *382
+ instances_url: *379
state: *92
fixed_at: *102
dismissed_by:
@@ -52892,11 +52473,11 @@ paths:
required: *18
nullable: true
dismissed_at: *101
- dismissed_reason: *383
- dismissed_comment: *384
- rule: *385
- tool: *386
- most_recent_instance: *387
+ dismissed_reason: *380
+ dismissed_comment: *381
+ rule: *382
+ tool: *383
+ most_recent_instance: *384
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -53022,7 +52603,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *42
- '403': &388
+ '403': &385
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -53049,9 +52630,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *302
- - *303
- - &389
+ - *299
+ - *300
+ - &386
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -53065,7 +52646,7 @@ paths:
description: Response
content:
application/json:
- schema: &390
+ schema: &387
type: object
properties:
number: *93
@@ -53073,7 +52654,7 @@ paths:
updated_at: *100
url: *97
html_url: *98
- instances_url: *382
+ instances_url: *379
state: *92
fixed_at: *102
dismissed_by:
@@ -53084,8 +52665,8 @@ paths:
required: *18
nullable: true
dismissed_at: *101
- dismissed_reason: *383
- dismissed_comment: *384
+ dismissed_reason: *380
+ dismissed_comment: *381
rule:
type: object
properties:
@@ -53139,8 +52720,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *386
- most_recent_instance: *387
+ tool: *383
+ most_recent_instance: *384
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -53239,7 +52820,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *42
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53259,9 +52840,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
requestBody:
required: true
content:
@@ -53276,8 +52857,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *383
- dismissed_comment: *384
+ dismissed_reason: *380
+ dismissed_comment: *381
assignees:
description: The list of users to assign to the code scanning alert.
An empty array unassigns all previous assignees from the alert.
@@ -53303,7 +52884,7 @@ paths:
description: Response
content:
application/json:
- schema: *390
+ schema: *387
examples:
default:
value:
@@ -53379,7 +52960,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *34
- '403': &399
+ '403': &396
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -53406,12 +52987,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
- *5
- *4
- - *391
+ - *388
responses:
'200':
description: Response
@@ -53422,10 +53003,10 @@ paths:
items:
type: object
properties:
- ref: *380
- analysis_key: *392
- environment: *393
- category: *394
+ ref: *377
+ analysis_key: *389
+ environment: *390
+ category: *391
state:
type: string
description: State of a code scanning alert instance.
@@ -53440,7 +53021,7 @@ paths:
properties:
text:
type: string
- location: *395
+ location: *392
html_url:
type: string
classifications:
@@ -53448,7 +53029,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: *396
+ items: *393
examples:
default:
value:
@@ -53487,7 +53068,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53521,8 +53102,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *183
- *184
- *5
@@ -53533,12 +53114,12 @@ paths:
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *380
+ schema: *377
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &397
+ schema: &394
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -53559,23 +53140,23 @@ paths:
application/json:
schema:
type: array
- items: &398
+ items: &395
type: object
properties:
- ref: *380
- commit_sha: &400
+ ref: *377
+ commit_sha: &397
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: *392
+ analysis_key: *389
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *394
+ category: *391
error:
type: string
example: error reading field xyz
@@ -53599,8 +53180,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *397
- tool: *386
+ sarif_id: *394
+ tool: *383
deletable:
type: boolean
warning:
@@ -53661,7 +53242,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53697,8 +53278,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -53711,7 +53292,7 @@ paths:
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
response:
summary: application/json response
@@ -53765,7 +53346,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53847,8 +53428,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -53901,7 +53482,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': *34
- '403': *399
+ '403': *396
'404': *26
'503': *104
x-github:
@@ -53923,8 +53504,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -53986,7 +53567,7 @@ paths:
query_suite: default
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -54007,8 +53588,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -54079,7 +53660,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *399
+ '403': *396
'404': *26
'409':
description: Response if there is already a validation run in progress with
@@ -54150,8 +53731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -54159,7 +53740,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *400
+ commit_sha: *397
ref:
type: string
description: |-
@@ -54212,7 +53793,7 @@ paths:
schema:
type: object
properties:
- id: *397
+ id: *394
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -54226,7 +53807,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': *399
+ '403': *396
'404': *26
'413':
description: Payload Too Large if the sarif field is too large
@@ -54249,8 +53830,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -54296,7 +53877,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': *388
+ '403': *385
'404':
description: Not Found if the sarif id does not match any upload
'503': *104
@@ -54321,8 +53902,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-codeowners-errors
parameters:
- - *302
- - *303
+ - *299
+ - *300
- 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
@@ -54445,8 +54026,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -54488,7 +54069,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &401
+ properties: &398
login:
type: string
example: octocat
@@ -54581,7 +54162,7 @@ paths:
user_view_type:
type: string
example: public
- required: &402
+ required: &399
- avatar_url
- events_url
- followers_url
@@ -54654,8 +54235,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
responses:
'204':
@@ -54692,8 +54273,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
requestBody:
required: false
@@ -54763,8 +54344,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
responses:
'204':
@@ -54796,8 +54377,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
responses:
'200':
@@ -54818,8 +54399,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *401
- required: *402
+ properties: *398
+ required: *399
nullable: true
required:
- permission
@@ -54874,8 +54455,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -54885,7 +54466,7 @@ paths:
application/json:
schema:
type: array
- items: &403
+ items: &400
title: Commit Comment
description: Commit Comment
type: object
@@ -54943,7 +54524,7 @@ paths:
- created_at
- updated_at
examples:
- default: &408
+ default: &405
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55002,17 +54583,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
- default: &409
+ default: &406
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55069,8 +54650,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#update-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -55093,7 +54674,7 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
default:
value:
@@ -55144,8 +54725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#delete-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'204':
@@ -55167,8 +54748,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -55195,7 +54776,7 @@ paths:
application/json:
schema:
type: array
- items: &404
+ items: &401
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -55238,7 +54819,7 @@ paths:
- content
- created_at
examples:
- default: &464
+ default: &461
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -55283,8 +54864,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -55317,9 +54898,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: &405
+ default: &402
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -55348,9 +54929,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -55372,10 +54953,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- - &465
+ - &462
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -55430,8 +55011,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -55487,9 +55068,9 @@ paths:
application/json:
schema:
type: array
- items: *406
+ items: *403
examples:
- default: &513
+ default: &510
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -55582,9 +55163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *302
- - *303
- - &407
+ - *299
+ - *300
+ - &404
name: commit_sha
description: The SHA of the commit.
in: path
@@ -55656,9 +55237,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
- *4
- *5
responses:
@@ -55668,9 +55249,9 @@ paths:
application/json:
schema:
type: array
- items: *403
+ items: *400
examples:
- default: *408
+ default: *405
headers:
Link: *6
x-github:
@@ -55698,9 +55279,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#create-a-commit-comment
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
requestBody:
required: true
content:
@@ -55735,9 +55316,9 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
- default: *409
+ default: *406
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55765,9 +55346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
- *4
- *5
responses:
@@ -55777,7 +55358,7 @@ paths:
application/json:
schema:
type: array
- items: &505
+ items: &502
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -55929,7 +55510,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *304
+ items: *301
nullable: true
head:
type: object
@@ -55998,7 +55579,7 @@ paths:
- review_comment
- self
author_association: *110
- auto_merge: *410
+ auto_merge: *407
draft:
description: Indicates whether or not the pull request is a
draft.
@@ -56037,7 +55618,7 @@ paths:
- author_association
- auto_merge
examples:
- default: &506
+ default: &503
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -56574,11 +56155,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#get-a-commit
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *5
- *4
- - &411
+ - &408
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)"
@@ -56593,9 +56174,9 @@ paths:
description: Response
content:
application/json:
- schema: *406
+ schema: *403
examples:
- default: &490
+ default: &487
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -56705,11 +56286,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *302
- - *303
- - *411
- - *412
- - *413
+ - *299
+ - *300
+ - *408
+ - *409
+ - *410
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -56743,9 +56324,9 @@ paths:
type: integer
check_runs:
type: array
- items: *372
+ items: *369
examples:
- default: *414
+ default: *411
headers:
Link: *6
x-github:
@@ -56770,9 +56351,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *302
- - *303
- - *411
+ - *299
+ - *300
+ - *408
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -56780,7 +56361,7 @@ paths:
schema:
type: integer
example: 1
- - *412
+ - *409
- *4
- *5
responses:
@@ -56798,7 +56379,7 @@ paths:
type: integer
check_suites:
type: array
- items: *377
+ items: *374
examples:
default:
value:
@@ -56998,9 +56579,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *302
- - *303
- - *411
+ - *299
+ - *300
+ - *408
- *4
- *5
responses:
@@ -57198,9 +56779,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *302
- - *303
- - *411
+ - *299
+ - *300
+ - *408
- *4
- *5
responses:
@@ -57210,7 +56791,7 @@ paths:
application/json:
schema:
type: array
- items: &546
+ items: &543
title: Status
description: The status of a commit.
type: object
@@ -57291,7 +56872,7 @@ paths:
site_admin: false
headers:
Link: *6
- '301': *314
+ '301': *311
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57359,8 +56940,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#compare-two-commits
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *5
- *4
- name: basehead
@@ -57403,8 +56984,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *406
- merge_base_commit: *406
+ base_commit: *403
+ merge_base_commit: *403
status:
type: string
enum:
@@ -57424,10 +57005,10 @@ paths:
example: 6
commits:
type: array
- items: *406
+ items: *403
files:
type: array
- items: *415
+ items: *412
required:
- url
- html_url
@@ -57706,8 +57287,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-repository-content
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: path
description: path parameter
in: path
@@ -57850,7 +57431,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &416
+ response-if-content-is-a-file: &413
summary: Response if content is a file
value:
type: file
@@ -57982,7 +57563,7 @@ paths:
- size
- type
- url
- - &518
+ - &515
title: Content File
description: Content File
type: object
@@ -58183,7 +57764,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *416
+ response-if-content-is-a-file: *413
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -58252,7 +57833,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *26
'403': *43
- '302': &522
+ '302': &519
description: Found
'304': *42
x-github:
@@ -58276,8 +57857,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#create-or-update-file-contents
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: path
description: path parameter
in: path
@@ -58370,7 +57951,7 @@ paths:
description: Response
content:
application/json:
- schema: &417
+ schema: &414
title: File Commit
description: File Commit
type: object
@@ -58516,7 +58097,7 @@ paths:
description: Response
content:
application/json:
- schema: *417
+ schema: *414
examples:
example-for-creating-a-file:
value:
@@ -58567,7 +58148,7 @@ paths:
schema:
oneOf:
- *24
- - &448
+ - &445
description: Repository rule violation was detected
type: object
properties:
@@ -58620,8 +58201,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#delete-a-file
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: path
description: path parameter
in: path
@@ -58682,7 +58263,7 @@ paths:
description: Response
content:
application/json:
- schema: *417
+ schema: *414
examples:
default:
value:
@@ -58733,8 +58314,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-contributors
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -58857,8 +58438,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *191
- *192
- *193
@@ -58870,7 +58451,7 @@ paths:
schema:
type: string
- *195
- - *418
+ - *415
- *196
- *197
- *9
@@ -58901,7 +58482,7 @@ paths:
application/json:
schema:
type: array
- items: &422
+ items: &419
type: object
description: A Dependabot alert.
properties:
@@ -58934,7 +58515,7 @@ paths:
enum:
- development
- runtime
- security_advisory: *419
+ security_advisory: *416
security_vulnerability: *96
url: *97
html_url: *98
@@ -58965,8 +58546,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *102
- auto_dismissed_at: *420
- dismissal_request: *421
+ auto_dismissed_at: *417
+ dismissal_request: *418
required:
- number
- state
@@ -59193,9 +58774,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *302
- - *303
- - &423
+ - *299
+ - *300
+ - &420
name: alert_number
in: path
description: |-
@@ -59210,7 +58791,7 @@ paths:
description: Response
content:
application/json:
- schema: *422
+ schema: *419
examples:
default:
value:
@@ -59314,9 +58895,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *302
- - *303
- - *423
+ - *299
+ - *300
+ - *420
requestBody:
required: true
content:
@@ -59361,7 +58942,7 @@ paths:
description: Response
content:
application/json:
- schema: *422
+ schema: *419
examples:
default:
value:
@@ -59490,8 +59071,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -59509,7 +59090,7 @@ paths:
type: integer
secrets:
type: array
- items: &426
+ items: &423
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -59562,16 +59143,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *424
+ schema: *421
examples:
- default: *425
+ default: *422
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59591,15 +59172,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *426
+ schema: *423
examples:
default:
value:
@@ -59625,8 +59206,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
requestBody:
required: true
@@ -59679,8 +59260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'204':
@@ -59703,8 +59284,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *302
- - *303
+ - *299
+ - *300
- 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
@@ -59864,8 +59445,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -60090,8 +59671,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -60166,7 +59747,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &427
+ metadata: &424
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -60199,7 +59780,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *427
+ metadata: *424
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -60212,7 +59793,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *427
+ metadata: *424
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -60341,8 +59922,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -60382,9 +59963,9 @@ paths:
application/json:
schema:
type: array
- items: *428
+ items: *425
examples:
- default: *429
+ default: *426
headers:
Link: *6
x-github:
@@ -60450,8 +60031,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#create-a-deployment
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -60532,7 +60113,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
simple-example:
summary: Simple example
@@ -60605,9 +60186,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#get-a-deployment
parameters:
- - *302
- - *303
- - &430
+ - *299
+ - *300
+ - &427
name: deployment_id
description: deployment_id parameter
in: path
@@ -60619,7 +60200,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
default:
value:
@@ -60684,9 +60265,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#delete-a-deployment
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
responses:
'204':
description: Response
@@ -60708,9 +60289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
- *4
- *5
responses:
@@ -60720,7 +60301,7 @@ paths:
application/json:
schema:
type: array
- items: &431
+ items: &428
title: Deployment Status
description: The status of a deployment.
type: object
@@ -60881,9 +60462,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
requestBody:
required: true
content:
@@ -60958,9 +60539,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: &432
+ default: &429
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -61016,9 +60597,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
- name: status_id
in: path
required: true
@@ -61029,9 +60610,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: *432
+ default: *429
'404': *26
x-github:
githubCloudOnly: false
@@ -61056,8 +60637,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -61114,8 +60695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#list-environments
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -61132,7 +60713,7 @@ paths:
type: integer
environments:
type: array
- items: &434
+ items: &431
title: Environment
description: Details of a deployment environment
type: object
@@ -61184,7 +60765,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &436
+ wait_timer: &433
type: integer
example: 30
description: The amount of time to delay a job after
@@ -61221,11 +60802,11 @@ paths:
items:
type: object
properties:
- type: *433
+ type: *430
reviewer:
anyOf:
- *19
- - *304
+ - *301
required:
- id
- node_id
@@ -61245,7 +60826,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &437
+ deployment_branch_policy: &434
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -61360,9 +60941,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#get-an-environment
parameters:
- - *302
- - *303
- - &435
+ - *299
+ - *300
+ - &432
name: environment_name
in: path
required: true
@@ -61375,9 +60956,9 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *431
examples:
- default: &438
+ default: &435
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -61460,9 +61041,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
requestBody:
required: false
content:
@@ -61471,7 +61052,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *436
+ wait_timer: *433
prevent_self_review:
type: boolean
example: false
@@ -61488,13 +61069,13 @@ paths:
items:
type: object
properties:
- type: *433
+ type: *430
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *437
+ deployment_branch_policy: *434
additionalProperties: false
examples:
default:
@@ -61514,9 +61095,9 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *431
examples:
- default: *438
+ default: *435
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -61540,9 +61121,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#delete-an-environment
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
responses:
'204':
description: Default response
@@ -61567,9 +61148,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *4
- *5
responses:
@@ -61587,7 +61168,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &439
+ items: &436
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -61644,9 +61225,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
requestBody:
required: true
content:
@@ -61692,9 +61273,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- example-wildcard: &440
+ example-wildcard: &437
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -61736,10 +61317,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
- - &441
+ - *299
+ - *300
+ - *432
+ - &438
name: branch_policy_id
in: path
required: true
@@ -61751,9 +61332,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61772,10 +61353,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
- - *441
+ - *299
+ - *300
+ - *432
+ - *438
requestBody:
required: true
content:
@@ -61803,9 +61384,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61824,10 +61405,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
- - *441
+ - *299
+ - *300
+ - *432
+ - *438
responses:
'204':
description: Response
@@ -61852,9 +61433,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *435
- - *303
- - *302
+ - *432
+ - *300
+ - *299
responses:
'200':
description: List of deployment protection rules
@@ -61870,7 +61451,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &442
+ items: &439
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -61889,7 +61470,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &443
+ app: &440
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -61988,9 +61569,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *435
- - *303
- - *302
+ - *432
+ - *300
+ - *299
requestBody:
content:
application/json:
@@ -62011,9 +61592,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: &444
+ default: &441
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -62048,9 +61629,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *435
- - *303
- - *302
+ - *432
+ - *300
+ - *299
- *5
- *4
responses:
@@ -62069,7 +61650,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *443
+ items: *440
examples:
default:
value:
@@ -62104,10 +61685,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *302
- - *303
- - *435
- - &445
+ - *299
+ - *300
+ - *432
+ - &442
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -62119,9 +61700,9 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: *444
+ default: *441
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62142,10 +61723,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *435
- - *303
- - *302
- - *445
+ - *432
+ - *300
+ - *299
+ - *442
responses:
'204':
description: Response
@@ -62171,9 +61752,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-environment-secrets
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *4
- *5
responses:
@@ -62191,9 +61772,9 @@ paths:
type: integer
secrets:
type: array
- items: *339
+ items: *336
examples:
- default: *340
+ default: *337
headers:
Link: *6
x-github:
@@ -62218,17 +61799,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
responses:
'200':
description: Response
content:
application/json:
- schema: *341
+ schema: *338
examples:
- default: *342
+ default: *339
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62250,18 +61831,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-secret
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *339
+ schema: *336
examples:
- default: *446
+ default: *443
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62283,9 +61864,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *168
requestBody:
required: true
@@ -62343,9 +61924,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *168
responses:
'204':
@@ -62371,10 +61952,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-environment-variables
parameters:
- - *302
- - *303
- - *435
- - *326
+ - *299
+ - *300
+ - *432
+ - *323
- *5
responses:
'200':
@@ -62391,9 +61972,9 @@ paths:
type: integer
variables:
type: array
- items: *343
+ items: *340
examples:
- default: *344
+ default: *341
headers:
Link: *6
x-github:
@@ -62416,9 +61997,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-an-environment-variable
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
requestBody:
required: true
content:
@@ -62470,18 +62051,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-an-environment-variable
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *171
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: *447
+ default: *444
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62502,10 +62083,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-an-environment-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
- - *435
+ - *432
requestBody:
required: true
content:
@@ -62547,10 +62128,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-an-environment-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
- - *435
+ - *432
responses:
'204':
description: Response
@@ -62572,8 +62153,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-repository-events
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -62651,8 +62232,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#list-forks
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -62811,8 +62392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#create-a-fork
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -62844,9 +62425,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
+ default: *312
'400': *34
'422': *35
'403': *43
@@ -62867,8 +62448,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#create-a-blob
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -62928,7 +62509,7 @@ paths:
schema:
oneOf:
- *143
- - *448
+ - *445
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62953,8 +62534,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#get-a-blob
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: file_sha
in: path
required: true
@@ -63053,8 +62634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -63163,7 +62744,7 @@ paths:
description: Response
content:
application/json:
- schema: &449
+ schema: &446
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -63370,15 +62951,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#get-a-commit-object
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
responses:
'200':
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default:
value:
@@ -63431,9 +63012,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#list-matching-references
parameters:
- - *302
- - *303
- - &450
+ - *299
+ - *300
+ - &447
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.
@@ -63450,7 +63031,7 @@ paths:
application/json:
schema:
type: array
- items: &451
+ items: &448
title: Git Reference
description: Git references within a repository
type: object
@@ -63525,17 +63106,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference
parameters:
- - *302
- - *303
- - *450
+ - *299
+ - *300
+ - *447
responses:
'200':
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: &452
+ default: &449
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -63564,8 +63145,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -63594,9 +63175,9 @@ paths:
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: *452
+ default: *449
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -63622,9 +63203,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference
parameters:
- - *302
- - *303
- - *450
+ - *299
+ - *300
+ - *447
requestBody:
required: true
content:
@@ -63653,9 +63234,9 @@ paths:
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: *452
+ default: *449
'422': *35
'409': *145
x-github:
@@ -63673,9 +63254,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#delete-a-reference
parameters:
- - *302
- - *303
- - *450
+ - *299
+ - *300
+ - *447
responses:
'204':
description: Response
@@ -63730,8 +63311,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#create-a-tag-object
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -63798,7 +63379,7 @@ paths:
description: Response
content:
application/json:
- schema: &454
+ schema: &451
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -63849,7 +63430,7 @@ paths:
- sha
- type
- url
- verification: *453
+ verification: *450
required:
- sha
- url
@@ -63859,7 +63440,7 @@ paths:
- tag
- message
examples:
- default: &455
+ default: &452
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -63929,8 +63510,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#get-a-tag
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tag_sha
in: path
required: true
@@ -63941,9 +63522,9 @@ paths:
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
'404': *26
'409': *145
x-github:
@@ -63967,8 +63548,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#create-a-tree
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -64041,7 +63622,7 @@ paths:
description: Response
content:
application/json:
- schema: &456
+ schema: &453
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -64137,8 +63718,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -64161,7 +63742,7 @@ paths:
description: Response
content:
application/json:
- schema: *456
+ schema: *453
examples:
default-response:
summary: Default response
@@ -64220,8 +63801,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -64231,7 +63812,7 @@ paths:
application/json:
schema:
type: array
- items: &457
+ items: &454
title: Webhook
description: Webhooks for repositories.
type: object
@@ -64285,7 +63866,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &658
+ last_response: &653
title: Hook Response
type: object
properties:
@@ -64359,8 +63940,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -64412,9 +63993,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: &458
+ default: &455
value:
type: Repository
id: 12345678
@@ -64462,17 +64043,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
'404': *26
x-github:
githubCloudOnly: false
@@ -64492,8 +64073,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
requestBody:
required: true
@@ -64539,9 +64120,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
'422': *35
'404': *26
x-github:
@@ -64562,8 +64143,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'204':
@@ -64588,8 +64169,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'200':
@@ -64617,8 +64198,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
requestBody:
required: false
@@ -64663,8 +64244,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
- *4
- *207
@@ -64696,8 +64277,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
- *36
responses:
@@ -64726,8 +64307,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
- *36
responses:
@@ -64751,8 +64332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'204':
@@ -64778,8 +64359,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'204':
@@ -64804,8 +64385,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -64813,8 +64394,8 @@ paths:
application/json:
schema: *39
examples:
- default: *459
- '301': *314
+ default: *456
+ '301': *311
'404': *26
x-github:
githubCloudOnly: false
@@ -64833,8 +64414,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -64844,7 +64425,7 @@ paths:
application/json:
schema:
type: array
- items: &460
+ items: &457
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -64907,7 +64488,7 @@ paths:
- html_url
- created_at
examples:
- default: &607
+ default: &602
value:
- id: 1
repository:
@@ -65038,9 +64619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *302
- - *303
- - &461
+ - *299
+ - *300
+ - &458
name: invitation_id
description: The unique identifier of the invitation.
in: path
@@ -65075,7 +64656,7 @@ paths:
description: Response
content:
application/json:
- schema: *460
+ schema: *457
examples:
default:
value:
@@ -65206,9 +64787,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *302
- - *303
- - *461
+ - *299
+ - *300
+ - *458
responses:
'204':
description: Response
@@ -65239,8 +64820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-repository-issues
parameters:
- - *302
- - *303
+ - *299
+ - *300
- 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
@@ -65461,7 +65042,7 @@ paths:
state_reason: completed
headers:
Link: *6
- '301': *314
+ '301': *311
'422': *35
'404': *26
x-github:
@@ -65490,8 +65071,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#create-an-issue
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -65575,7 +65156,7 @@ paths:
application/json:
schema: *109
examples:
- default: &469
+ default: &466
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -65759,9 +65340,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *302
- - *303
- - &511
+ - *299
+ - *300
+ - &508
name: sort
description: The property to sort the results by.
in: query
@@ -65791,9 +65372,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: &471
+ default: &468
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -65851,17 +65432,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: &463
+ default: &460
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -65915,8 +65496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#update-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -65939,9 +65520,9 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *35
x-github:
githubCloudOnly: false
@@ -65959,8 +65540,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#delete-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'204':
@@ -65981,8 +65562,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -66009,9 +65590,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -66032,8 +65613,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -66066,16 +65647,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -66097,10 +65678,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- - *465
+ - *462
responses:
'204':
description: Response
@@ -66120,8 +65701,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -66131,7 +65712,7 @@ paths:
application/json:
schema:
type: array
- items: &468
+ items: &465
title: Issue Event
description: Issue Event
type: object
@@ -66174,8 +65755,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *466
- required: *467
+ properties: *463
+ required: *464
nullable: true
label:
title: Issue Event Label
@@ -66219,7 +65800,7 @@ paths:
properties: *17
required: *18
nullable: true
- requested_team: *304
+ requested_team: *301
dismissed_review:
title: Issue Event Dismissed Review
type: object
@@ -66482,8 +66063,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#get-an-issue-event
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: event_id
in: path
required: true
@@ -66494,7 +66075,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -66720,9 +66301,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue
parameters:
- - *302
- - *303
- - &470
+ - *299
+ - *300
+ - &467
name: issue_number
description: The number that identifies the issue.
in: path
@@ -66736,8 +66317,8 @@ paths:
application/json:
schema: *109
examples:
- default: *469
- '301': *314
+ default: *466
+ '301': *311
'404': *26
'410': *243
'304': *42
@@ -66764,9 +66345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#update-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -66872,11 +66453,11 @@ paths:
application/json:
schema: *109
examples:
- default: *469
+ default: *466
'422': *35
'503': *104
'403': *43
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -66896,9 +66477,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -66926,7 +66507,7 @@ paths:
application/json:
schema: *109
examples:
- default: *469
+ default: *466
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66942,9 +66523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
content:
application/json:
@@ -66971,7 +66552,7 @@ paths:
application/json:
schema: *109
examples:
- default: *469
+ default: *466
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66993,9 +66574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- name: assignee
in: path
required: true
@@ -67035,9 +66616,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *119
- *4
- *5
@@ -67048,9 +66629,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *471
+ default: *468
headers:
Link: *6
'404': *26
@@ -67083,9 +66664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: true
content:
@@ -67107,9 +66688,9 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
@@ -67136,9 +66717,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *4
- *5
responses:
@@ -67152,7 +66733,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &473
+ - &470
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -67206,7 +66787,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &474
+ - &471
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -67342,7 +66923,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &475
+ - &472
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -67393,7 +66974,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &476
+ - &473
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -67444,7 +67025,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &477
+ - &474
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -67498,7 +67079,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &478
+ - &475
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -67532,7 +67113,7 @@ paths:
properties: *106
required: *107
review_requester: *19
- requested_team: *304
+ requested_team: *301
requested_reviewer: *19
required:
- review_requester
@@ -67545,7 +67126,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &479
+ - &476
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -67579,7 +67160,7 @@ paths:
properties: *106
required: *107
review_requester: *19
- requested_team: *304
+ requested_team: *301
requested_reviewer: *19
required:
- review_requester
@@ -67592,7 +67173,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &480
+ - &477
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -67652,7 +67233,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &481
+ - &478
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -67700,7 +67281,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &482
+ - &479
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -67766,7 +67347,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &483
+ - &480
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -67832,7 +67413,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &484
+ - &481
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -67898,7 +67479,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &485
+ - &482
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -68006,9 +67587,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *4
- *5
responses:
@@ -68020,7 +67601,7 @@ paths:
type: array
items: *108
examples:
- default: &472
+ default: &469
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -68038,7 +67619,7 @@ paths:
default: false
headers:
Link: *6
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -68057,9 +67638,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -68120,8 +67701,8 @@ paths:
type: array
items: *108
examples:
- default: *472
- '301': *314
+ default: *469
+ '301': *311
'404': *26
'410': *243
'422': *35
@@ -68140,9 +67721,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -68204,8 +67785,8 @@ paths:
type: array
items: *108
examples:
- default: *472
- '301': *314
+ default: *469
+ '301': *311
'404': *26
'410': *243
'422': *35
@@ -68224,13 +67805,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
responses:
'204':
description: Response
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -68251,9 +67832,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- name: name
in: path
required: true
@@ -68277,7 +67858,7 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -68299,9 +67880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#lock-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -68347,9 +67928,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#unlock-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
responses:
'204':
description: Response
@@ -68371,9 +67952,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -68399,9 +67980,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -68423,9 +68004,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: true
content:
@@ -68457,16 +68038,16 @@ paths:
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -68488,10 +68069,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *302
- - *303
- - *470
- - *465
+ - *299
+ - *300
+ - *467
+ - *462
responses:
'204':
description: Response
@@ -68511,9 +68092,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *4
- *5
responses:
@@ -68528,6 +68109,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *470
+ - *471
+ - *472
- *473
- *474
- *475
@@ -68538,9 +68122,6 @@ paths:
- *480
- *481
- *482
- - *483
- - *484
- - *485
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -68845,7 +68426,7 @@ paths:
type: string
comments:
type: array
- items: &507
+ items: &504
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -69054,7 +68635,7 @@ paths:
type: string
comments:
type: array
- items: *403
+ items: *400
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -69360,8 +68941,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -69371,7 +68952,7 @@ paths:
application/json:
schema:
type: array
- items: &486
+ items: &483
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -69435,8 +69016,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -69472,9 +69053,9 @@ paths:
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
- default: &487
+ default: &484
value:
id: 1
key: ssh-rsa AAA...
@@ -69507,9 +69088,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *302
- - *303
- - &488
+ - *299
+ - *300
+ - &485
name: key_id
description: The unique identifier of the key.
in: path
@@ -69521,9 +69102,9 @@ paths:
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
- default: *487
+ default: *484
'404': *26
x-github:
githubCloudOnly: false
@@ -69541,9 +69122,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *302
- - *303
- - *488
+ - *299
+ - *300
+ - *485
responses:
'204':
description: Response
@@ -69563,8 +69144,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -69576,7 +69157,7 @@ paths:
type: array
items: *108
examples:
- default: *472
+ default: *469
headers:
Link: *6
'404': *26
@@ -69597,8 +69178,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#create-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -69636,7 +69217,7 @@ paths:
application/json:
schema: *108
examples:
- default: &489
+ default: &486
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -69668,8 +69249,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#get-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: name
in: path
required: true
@@ -69682,7 +69263,7 @@ paths:
application/json:
schema: *108
examples:
- default: *489
+ default: *486
'404': *26
x-github:
githubCloudOnly: false
@@ -69699,8 +69280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#update-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: name
in: path
required: true
@@ -69765,8 +69346,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#delete-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: name
in: path
required: true
@@ -69792,8 +69373,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-languages
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -69829,8 +69410,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'202': *146
'403':
@@ -69858,8 +69439,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -69885,9 +69466,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *302
- - *303
- - *391
+ - *299
+ - *300
+ - *388
responses:
'200':
description: Response
@@ -70032,8 +69613,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70098,8 +69679,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#merge-a-branch
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70133,9 +69714,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *406
+ schema: *403
examples:
- default: *490
+ default: *487
'204':
description: Response when already merged
'404':
@@ -70160,8 +69741,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#list-milestones
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -70202,7 +69783,7 @@ paths:
application/json:
schema:
type: array
- items: &491
+ items: &488
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -70263,8 +69844,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#create-a-milestone
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70304,9 +69885,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: &492
+ default: &489
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -70365,9 +69946,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#get-a-milestone
parameters:
- - *302
- - *303
- - &493
+ - *299
+ - *300
+ - &490
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -70379,9 +69960,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: *492
+ default: *489
'404': *26
x-github:
githubCloudOnly: false
@@ -70398,9 +69979,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#update-a-milestone
parameters:
- - *302
- - *303
- - *493
+ - *299
+ - *300
+ - *490
requestBody:
required: false
content:
@@ -70438,9 +70019,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: *492
+ default: *489
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70456,9 +70037,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#delete-a-milestone
parameters:
- - *302
- - *303
- - *493
+ - *299
+ - *300
+ - *490
responses:
'204':
description: Response
@@ -70479,9 +70060,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *302
- - *303
- - *493
+ - *299
+ - *300
+ - *490
- *4
- *5
responses:
@@ -70493,7 +70074,7 @@ paths:
type: array
items: *108
examples:
- default: *472
+ default: *469
headers:
Link: *6
x-github:
@@ -70512,12 +70093,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *302
- - *303
- - *494
- - *495
+ - *299
+ - *300
+ - *491
+ - *492
- *119
- - *496
+ - *493
- *4
- *5
responses:
@@ -70529,7 +70110,7 @@ paths:
type: array
items: *136
examples:
- default: *497
+ default: *494
headers:
Link: *6
x-github:
@@ -70553,8 +70134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -70612,14 +70193,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: &498
+ schema: &495
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -70744,7 +70325,7 @@ paths:
- custom_404
- public
examples:
- default: &499
+ default: &496
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -70785,8 +70366,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70840,9 +70421,9 @@ paths:
description: Response
content:
application/json:
- schema: *498
+ schema: *495
examples:
- default: *499
+ default: *496
'422': *35
'409': *145
x-github:
@@ -70865,8 +70446,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70965,8 +70546,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -70992,8 +70573,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -71003,7 +70584,7 @@ paths:
application/json:
schema:
type: array
- items: &500
+ items: &497
title: Page Build
description: Page Build
type: object
@@ -71097,8 +70678,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'201':
description: Response
@@ -71143,16 +70724,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-latest-pages-build
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *500
+ schema: *497
examples:
- default: &501
+ default: &498
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -71200,8 +70781,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-apiname-pages-build
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: build_id
in: path
required: true
@@ -71212,9 +70793,9 @@ paths:
description: Response
content:
application/json:
- schema: *500
+ schema: *497
examples:
- default: *501
+ default: *498
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71234,8 +70815,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71335,9 +70916,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *302
- - *303
- - &502
+ - *299
+ - *300
+ - &499
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -71395,9 +70976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *302
- - *303
- - *502
+ - *299
+ - *300
+ - *499
responses:
'204': *239
'404': *26
@@ -71420,8 +71001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- *9
@@ -71442,7 +71023,7 @@ paths:
application/json:
schema:
type: array
- items: &503
+ items: &500
type: object
properties:
id:
@@ -71476,17 +71057,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: &504
+ default: &501
value:
id: 42
name: Check Commits
@@ -71508,15 +71089,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
default:
value:
@@ -71560,8 +71141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *16
responses:
'200':
@@ -71569,9 +71150,9 @@ paths:
global level.
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: *504
+ default: *501
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71591,8 +71172,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#list-repository-projects
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: state
description: Indicates the state of the projects to return.
in: query
@@ -71677,8 +71258,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#create-a-repository-project
deprecated: true
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71706,7 +71287,7 @@ paths:
application/json:
schema: *242
examples:
- default: *311
+ default: *308
'401': *41
'403': *43
'404': *26
@@ -71730,8 +71311,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -71770,8 +71351,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71833,8 +71414,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -71894,9 +71475,9 @@ paths:
application/json:
schema:
type: array
- items: *505
+ items: *502
examples:
- default: *506
+ default: *503
headers:
Link: *6
'304': *42
@@ -71928,8 +71509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#create-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71996,7 +71577,7 @@ paths:
application/json:
schema: *117
examples:
- default: &509
+ default: &506
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -72523,8 +72104,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sort
in: query
required: false
@@ -72553,9 +72134,9 @@ paths:
application/json:
schema:
type: array
- items: *507
+ items: *504
examples:
- default: &512
+ default: &509
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -72632,17 +72213,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: &508
+ default: &505
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -72717,8 +72298,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -72741,9 +72322,9 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: *508
+ default: *505
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72759,8 +72340,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'204':
@@ -72782,8 +72363,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -72810,9 +72391,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -72833,8 +72414,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -72867,16 +72448,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -72898,10 +72479,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- - *465
+ - *462
responses:
'204':
description: Response
@@ -72944,9 +72525,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request
parameters:
- - *302
- - *303
- - &510
+ - *299
+ - *300
+ - &507
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -72961,7 +72542,7 @@ paths:
application/json:
schema: *117
examples:
- default: *509
+ default: *506
'304': *42
'404': *26
'406':
@@ -72996,9 +72577,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -73042,7 +72623,7 @@ paths:
application/json:
schema: *117
examples:
- default: *509
+ default: *506
'422': *35
'403': *43
x-github:
@@ -73070,10 +72651,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *511
+ - *299
+ - *300
+ - *507
+ - *508
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
in: query
@@ -73093,9 +72674,9 @@ paths:
application/json:
schema:
type: array
- items: *507
+ items: *504
examples:
- default: *512
+ default: *509
headers:
Link: *6
x-github:
@@ -73128,9 +72709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: true
content:
@@ -73235,7 +72816,7 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
example-for-a-multi-line-comment:
value:
@@ -73323,9 +72904,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *128
requestBody:
required: true
@@ -73348,7 +72929,7 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
default:
value:
@@ -73434,9 +73015,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *4
- *5
responses:
@@ -73446,9 +73027,9 @@ paths:
application/json:
schema:
type: array
- items: *406
+ items: *403
examples:
- default: *513
+ default: *510
headers:
Link: *6
x-github:
@@ -73478,9 +73059,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *4
- *5
responses:
@@ -73490,7 +73071,7 @@ paths:
application/json:
schema:
type: array
- items: *415
+ items: *412
examples:
default:
value:
@@ -73528,9 +73109,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
responses:
'204':
description: Response if pull request has been merged
@@ -73553,9 +73134,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -73666,9 +73247,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
responses:
'200':
description: Response
@@ -73684,7 +73265,7 @@ paths:
items: *19
teams:
type: array
- items: *304
+ items: *301
required:
- users
- teams
@@ -73743,9 +73324,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -73782,7 +73363,7 @@ paths:
description: Response
content:
application/json:
- schema: *505
+ schema: *502
examples:
default:
value:
@@ -74318,9 +73899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: true
content:
@@ -74354,7 +73935,7 @@ paths:
description: Response
content:
application/json:
- schema: *505
+ schema: *502
examples:
default:
value:
@@ -74859,9 +74440,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *4
- *5
responses:
@@ -74871,7 +74452,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &511
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -75022,9 +74603,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -75110,9 +74691,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &516
+ default: &513
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -75175,10 +74756,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - &515
+ - *299
+ - *300
+ - *507
+ - &512
name: review_id
description: The unique identifier of the review.
in: path
@@ -75190,9 +74771,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &517
+ default: &514
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -75251,10 +74832,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
requestBody:
required: true
content:
@@ -75277,7 +74858,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -75339,18 +74920,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *516
+ default: *513
'422': *27
'404': *26
x-github:
@@ -75377,10 +74958,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
- *4
- *5
responses:
@@ -75615,10 +75196,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
requestBody:
required: true
content:
@@ -75646,7 +75227,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -75709,10 +75290,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
requestBody:
required: true
content:
@@ -75747,9 +75328,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *517
+ default: *514
'404': *26
'422': *27
'403': *43
@@ -75771,9 +75352,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -75836,8 +75417,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -75850,9 +75431,9 @@ paths:
description: Response
content:
application/json:
- schema: *518
+ schema: *515
examples:
- default: &519
+ default: &516
value:
type: file
encoding: base64
@@ -75894,8 +75475,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: dir
description: The alternate path to look for a README file
in: path
@@ -75915,9 +75496,9 @@ paths:
description: Response
content:
application/json:
- schema: *518
+ schema: *515
examples:
- default: *519
+ default: *516
'404': *26
'422': *35
x-github:
@@ -75939,8 +75520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#list-releases
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -75950,7 +75531,7 @@ paths:
application/json:
schema:
type: array
- items: *520
+ items: *517
examples:
default:
value:
@@ -76044,8 +75625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -76115,9 +75696,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: &525
+ default: &522
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -76217,9 +75798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#get-a-release-asset
parameters:
- - *302
- - *303
- - &523
+ - *299
+ - *300
+ - &520
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -76231,9 +75812,9 @@ paths:
description: Response
content:
application/json:
- schema: *521
+ schema: *518
examples:
- default: &524
+ default: &521
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
@@ -76268,7 +75849,7 @@ paths:
type: User
site_admin: false
'404': *26
- '302': *522
+ '302': *519
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76284,9 +75865,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#update-a-release-asset
parameters:
- - *302
- - *303
- - *523
+ - *299
+ - *300
+ - *520
requestBody:
required: false
content:
@@ -76314,9 +75895,9 @@ paths:
description: Response
content:
application/json:
- schema: *521
+ schema: *518
examples:
- default: *524
+ default: *521
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76332,9 +75913,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#delete-a-release-asset
parameters:
- - *302
- - *303
- - *523
+ - *299
+ - *300
+ - *520
responses:
'204':
description: Response
@@ -76358,8 +75939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -76444,16 +76025,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76470,8 +76051,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tag
description: tag parameter
in: path
@@ -76484,9 +76065,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
'404': *26
x-github:
githubCloudOnly: false
@@ -76508,9 +76089,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release
parameters:
- - *302
- - *303
- - &526
+ - *299
+ - *300
+ - &523
name: release_id
description: The unique identifier of the release.
in: path
@@ -76524,9 +76105,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
'401':
description: Unauthorized
x-github:
@@ -76544,9 +76125,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#update-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
requestBody:
required: false
content:
@@ -76603,9 +76184,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76621,9 +76202,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#delete-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
responses:
'204':
description: Response
@@ -76643,9 +76224,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
- *4
- *5
responses:
@@ -76655,7 +76236,7 @@ paths:
application/json:
schema:
type: array
- items: *521
+ items: *518
examples:
default:
value:
@@ -76737,9 +76318,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:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
- name: name
in: query
required: true
@@ -76765,7 +76346,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *521
+ schema: *518
examples:
response-for-successful-upload:
value:
@@ -76820,9 +76401,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -76846,9 +76427,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -76869,9 +76450,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
requestBody:
required: true
content:
@@ -76901,16 +76482,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -76932,10 +76513,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *302
- - *303
- - *526
- - *465
+ - *299
+ - *300
+ - *523
+ - *462
responses:
'204':
description: Response
@@ -76955,8 +76536,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-cache-replication-status
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -77031,9 +76612,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
- *4
- *5
responses:
@@ -77050,7 +76631,7 @@ paths:
oneOf:
- allOf:
- *257
- - &527
+ - &524
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -77071,49 +76652,49 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *258
- - *527
+ - *524
- allOf:
- *259
- - *527
+ - *524
- allOf:
- *260
- - *527
+ - *524
- allOf:
- *261
- - *527
+ - *524
- allOf:
- *262
- - *527
+ - *524
- allOf:
- *263
- - *527
+ - *524
- allOf:
- *264
- - *527
+ - *524
- allOf:
- *265
- - *527
+ - *524
- allOf:
- *266
- - *527
+ - *524
- allOf:
- *267
- - *527
+ - *524
- allOf:
- *268
- - *527
+ - *524
- allOf:
- *269
- - *527
+ - *524
- allOf:
- *270
- - *527
+ - *524
- allOf:
- *271
- - *527
+ - *524
- allOf:
- *272
- - *527
+ - *524
examples:
default:
value:
@@ -77152,8 +76733,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- name: includes_parents
@@ -77164,7 +76745,7 @@ paths:
schema:
type: boolean
default: true
- - *528
+ - *525
responses:
'200':
description: Response
@@ -77219,8 +76800,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
description: Request body
required: true
@@ -77249,7 +76830,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *529
+ items: *526
required:
- name
- enforcement
@@ -77282,7 +76863,7 @@ paths:
application/json:
schema: *273
examples:
- default: &539
+ default: &536
value:
id: 42
name: super cool ruleset
@@ -77329,12 +76910,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *302
- - *303
+ - *299
+ - *300
+ - *527
+ - *528
+ - *529
- *530
- - *531
- - *532
- - *533
- *4
- *5
responses:
@@ -77342,9 +76923,9 @@ paths:
description: Response
content:
application/json:
- schema: *534
+ schema: *531
examples:
- default: *535
+ default: *532
'404': *26
'500': *230
x-github:
@@ -77365,17 +76946,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *302
- - *303
- - *536
+ - *299
+ - *300
+ - *533
responses:
'200':
description: Response
content:
application/json:
- schema: *537
+ schema: *534
examples:
- default: *538
+ default: *535
'404': *26
'500': *230
x-github:
@@ -77403,8 +76984,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77426,7 +77007,7 @@ paths:
application/json:
schema: *273
examples:
- default: *539
+ default: *536
'404': *26
'500': *230
put:
@@ -77444,8 +77025,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77479,7 +77060,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *529
+ items: *526
examples:
default:
value:
@@ -77509,7 +77090,7 @@ paths:
application/json:
schema: *273
examples:
- default: *539
+ default: *536
'404': *26
'500': *230
delete:
@@ -77527,8 +77108,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77556,8 +77137,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *276
- *277
- *278
@@ -77565,8 +77146,8 @@ paths:
- *9
- *5
- *4
- - *540
- - *541
+ - *537
+ - *538
- *280
responses:
'200':
@@ -77575,7 +77156,7 @@ paths:
application/json:
schema:
type: array
- items: &544
+ items: &541
type: object
properties:
number: *93
@@ -77594,8 +77175,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *542
- resolution: *543
+ state: *539
+ resolution: *540
resolved_at:
type: string
format: date-time
@@ -77773,15 +77354,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
responses:
'200':
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -77821,9 +77402,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
requestBody:
required: true
content:
@@ -77831,8 +77412,8 @@ paths:
schema:
type: object
properties:
- state: *542
- resolution: *543
+ state: *539
+ resolution: *540
resolution_comment:
description: An optional comment when closing an alert. Cannot be
updated or deleted. Must be `null` when changing `state` to `open`.
@@ -77851,7 +77432,7 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -77918,9 +77499,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
- *5
- *4
responses:
@@ -77931,7 +77512,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &678
+ items: &673
type: object
properties:
type:
@@ -78290,8 +77871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-stargazers
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -78387,8 +77968,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -78397,7 +77978,7 @@ paths:
application/json:
schema:
type: array
- items: &545
+ items: &542
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -78428,8 +78009,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -78502,8 +78083,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -78599,8 +78180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -78754,8 +78335,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -78765,7 +78346,7 @@ paths:
application/json:
schema:
type: array
- items: *545
+ items: *542
examples:
default:
value:
@@ -78798,8 +78379,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#create-a-commit-status
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sha
in: path
required: true
@@ -78853,7 +78434,7 @@ paths:
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
default:
value:
@@ -78907,8 +78488,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-watchers
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -78940,14 +78521,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &547
+ schema: &544
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -79015,8 +78596,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -79042,7 +78623,7 @@ paths:
description: Response
content:
application/json:
- schema: *547
+ schema: *544
examples:
default:
value:
@@ -79069,8 +78650,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -79090,8 +78671,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -79170,8 +78751,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -79179,7 +78760,7 @@ paths:
application/json:
schema:
type: array
- items: &548
+ items: &545
title: Tag protection
description: Tag protection
type: object
@@ -79231,8 +78812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -79255,7 +78836,7 @@ paths:
description: Response
content:
application/json:
- schema: *548
+ schema: *545
examples:
default:
value:
@@ -79286,8 +78867,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -79324,8 +78905,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ref
in: path
required: true
@@ -79361,8 +78942,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-teams
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -79372,7 +78953,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
headers:
@@ -79394,8 +78975,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-all-repository-topics
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *5
- *4
responses:
@@ -79403,7 +78984,7 @@ paths:
description: Response
content:
application/json:
- schema: &549
+ schema: &546
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -79415,7 +78996,7 @@ paths:
required:
- names
examples:
- default: &550
+ default: &547
value:
names:
- octocat
@@ -79438,8 +79019,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -79470,9 +79051,9 @@ paths:
description: Response
content:
application/json:
- schema: *549
+ schema: *546
examples:
- default: *550
+ default: *547
'404': *26
'422': *27
x-github:
@@ -79495,8 +79076,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#transfer-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -79770,8 +79351,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -79794,8 +79375,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -79817,8 +79398,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -79844,8 +79425,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ref
in: path
required: true
@@ -79937,9 +79518,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
+ default: *312
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -80113,7 +79694,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &558
+ - &555
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -80122,7 +79703,7 @@ paths:
schema:
type: string
example: members
- - &563
+ - &560
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -80133,7 +79714,7 @@ paths:
default: 1
format: int32
example: 1
- - &564
+ - &561
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -80175,7 +79756,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &552
+ items: &549
allOf:
- type: object
required:
@@ -80250,7 +79831,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &565
+ meta: &562
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -80310,31 +79891,31 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &553
+ '400': &550
description: Bad request
content:
application/json:
- schema: *551
+ schema: *548
application/scim+json:
- schema: *551
- '401': &554
+ schema: *548
+ '401': &551
description: Authorization failure
- '403': &555
+ '403': &552
description: Permission denied
- '429': &556
+ '429': &553
description: Too many requests
content:
application/json:
- schema: *551
+ schema: *548
application/scim+json:
- schema: *551
- '500': &557
+ schema: *548
+ '500': &554
description: Internal server error
content:
application/json:
- schema: *551
+ schema: *548
application/scim+json:
- schema: *551
+ schema: *548
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80361,7 +79942,7 @@ paths:
required: true
content:
application/json:
- schema: &561
+ schema: &558
type: object
required:
- schemas
@@ -80421,9 +80002,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- group: &559
+ group: &556
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -80442,13 +80023,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *553
- '401': *554
- '403': *555
- '409': &562
+ '400': *550
+ '401': *551
+ '403': *552
+ '409': &559
description: Duplicate record detected
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80469,7 +80050,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &560
+ - &557
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -80477,22 +80058,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *558
+ - *555
- *65
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- default: *559
- '400': *553
- '401': *554
- '403': *555
+ default: *556
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80514,13 +80095,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *560
+ - *557
- *65
requestBody:
required: true
content:
application/json:
- schema: *561
+ schema: *558
examples:
group:
summary: Group
@@ -80546,17 +80127,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- group: *559
- groupWithMembers: *559
- '400': *553
- '401': *554
- '403': *555
+ group: *556
+ groupWithMembers: *556
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80580,13 +80161,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *560
+ - *557
- *65
requestBody:
required: true
content:
application/json:
- schema: &572
+ schema: &569
type: object
required:
- Operations
@@ -80646,17 +80227,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- updateGroup: *559
- addMembers: *559
- '400': *553
- '401': *554
- '403': *555
+ updateGroup: *556
+ addMembers: *556
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80676,17 +80257,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *560
+ - *557
- *65
responses:
'204':
description: Group was deleted, no content
- '400': *553
- '401': *554
- '403': *555
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80723,8 +80304,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *563
- - *564
+ - *560
+ - *561
- *65
responses:
'200':
@@ -80757,7 +80338,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &567
+ items: &564
allOf:
- type: object
required:
@@ -80836,7 +80417,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &566
+ roles: &563
type: array
description: The roles assigned to the user.
items:
@@ -80892,7 +80473,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *565
+ meta: *562
startIndex:
type: integer
description: A starting index for the returned page
@@ -80929,11 +80510,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *553
- '401': *554
- '403': *555
- '429': *556
- '500': *557
+ '400': *550
+ '401': *551
+ '403': *552
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80962,7 +80543,7 @@ paths:
required: true
content:
application/json:
- schema: &570
+ schema: &567
type: object
required:
- schemas
@@ -81044,9 +80625,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *566
+ roles: *563
examples:
- user: &571
+ user: &568
summary: User
value:
schemas:
@@ -81093,9 +80674,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *567
+ schema: *564
examples:
- user: &568
+ user: &565
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -81121,13 +80702,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *568
- '400': *553
- '401': *554
- '403': *555
- '409': *562
- '429': *556
- '500': *557
+ enterpriseOwner: *565
+ '400': *550
+ '401': *551
+ '403': *552
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81148,7 +80729,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &569
+ - &566
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -81161,15 +80742,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *567
+ schema: *564
examples:
- default: *568
- '400': *553
- '401': *554
- '403': *555
+ default: *565
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81194,30 +80775,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *569
+ - *566
- *65
requestBody:
required: true
content:
application/json:
- schema: *570
+ schema: *567
examples:
- user: *571
+ user: *568
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *567
+ schema: *564
examples:
- user: *568
- '400': *553
- '401': *554
- '403': *555
+ user: *565
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81255,13 +80836,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *569
+ - *566
- *65
requestBody:
required: true
content:
application/json:
- schema: *572
+ schema: *569
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -81301,18 +80882,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *567
- examples:
- userMultiValuedProperties: *568
- userSingleValuedProperties: *568
- disableUser: *568
- '400': *553
- '401': *554
- '403': *555
+ schema: *564
+ examples:
+ userMultiValuedProperties: *565
+ userSingleValuedProperties: *565
+ disableUser: *565
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81332,17 +80913,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *569
+ - *566
- *65
responses:
'204':
description: User was deleted, no content
- '400': *553
- '401': *554
- '403': *555
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81469,7 +81050,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &573
+ text_matches: &570
title: Search Result Text Matches
type: array
items:
@@ -81632,7 +81213,7 @@ paths:
enum:
- author-date
- committer-date
- - &574
+ - &571
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
@@ -81703,7 +81284,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *358
+ properties: *355
nullable: true
comment_count:
type: integer
@@ -81723,7 +81304,7 @@ paths:
url:
type: string
format: uri
- verification: *453
+ verification: *450
required:
- author
- committer
@@ -81742,7 +81323,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *358
+ properties: *355
nullable: true
parents:
type: array
@@ -81760,7 +81341,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *573
+ text_matches: *570
required:
- sha
- node_id
@@ -81953,7 +81534,7 @@ paths:
- interactions
- created
- updated
- - *574
+ - *571
- *4
- *5
- name: advanced_search
@@ -82050,11 +81631,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
type: string
state_reason:
@@ -82086,7 +81667,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *573
+ text_matches: *570
pull_request:
type: object
properties:
@@ -82130,7 +81711,7 @@ paths:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
performed_via_github_app:
title: GitHub app
description: GitHub apps are a new way to extend GitHub.
@@ -82311,7 +81892,7 @@ paths:
enum:
- created
- updated
- - *574
+ - *571
- *4
- *5
responses:
@@ -82355,7 +81936,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *573
+ text_matches: *570
required:
- id
- node_id
@@ -82441,7 +82022,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *574
+ - *571
- *4
- *5
responses:
@@ -82680,7 +82261,7 @@ paths:
- admin
- pull
- push
- text_matches: *573
+ text_matches: *570
temp_clone_token:
type: string
allow_merge_commit:
@@ -82981,7 +82562,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *573
+ text_matches: *570
related:
type: array
nullable: true
@@ -83174,7 +82755,7 @@ paths:
- followers
- repositories
- joined
- - *574
+ - *571
- *4
- *5
responses:
@@ -83278,7 +82859,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *573
+ text_matches: *570
blog:
type: string
nullable: true
@@ -83473,7 +83054,7 @@ paths:
description: Response
content:
application/json:
- schema: &579
+ schema: &576
type: object
properties:
status:
@@ -83493,7 +83074,7 @@ paths:
- name
- number
examples:
- default: &580
+ default: &577
value:
status: scheduled
scheduled_time: Tuesday, January 22 at 15:34 -0800
@@ -83538,9 +83119,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
'401':
description: Unauthorized
requestBody:
@@ -84104,7 +83685,7 @@ paths:
application/json:
schema:
type: array
- items: &581
+ items: &578
type: object
properties:
key:
@@ -84112,7 +83693,7 @@ paths:
pretty-print:
type: string
examples:
- default: &582
+ default: &579
value:
- key: ssh-rsa AAAAB3NzaC1yc2EAAAAB...
pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64
@@ -84155,9 +83736,9 @@ paths:
application/json:
schema:
type: array
- items: *581
+ items: *578
examples:
- default: *582
+ default: *579
'401':
description: Unauthorized
requestBody:
@@ -84209,9 +83790,9 @@ paths:
application/json:
schema:
type: array
- items: *581
+ items: *578
examples:
- default: *582
+ default: *579
'401':
description: Unauthorized
requestBody:
@@ -84541,7 +84122,7 @@ paths:
type: array
items: *289
examples:
- default: *583
+ default: *580
headers:
Link: *6
x-github:
@@ -84693,7 +84274,7 @@ paths:
application/json:
schema: *289
examples:
- default: *584
+ default: *581
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84731,218 +84312,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - *7
- - *291
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *292
- examples:
- default: *585
- headers:
- Link: *6
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *293
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- - *294
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *293
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- - *294
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *586
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- - *294
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/members":
get:
summary: List team members (Legacy)
@@ -85130,9 +84499,9 @@ paths:
description: Response
content:
application/json:
- schema: *299
+ schema: *296
examples:
- response-if-user-is-a-team-maintainer: *587
+ response-if-user-is-a-team-maintainer: *582
'404': *26
x-github:
githubCloudOnly: false
@@ -85191,9 +84560,9 @@ paths:
description: Response
content:
application/json:
- schema: *299
+ schema: *296
examples:
- response-if-users-membership-with-team-is-now-pending: *588
+ response-if-users-membership-with-team-is-now-pending: *583
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -85266,9 +84635,9 @@ paths:
application/json:
schema:
type: array
- items: *300
+ items: *297
examples:
- default: *589
+ default: *584
headers:
Link: *6
'404': *26
@@ -85295,15 +84664,15 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project-legacy
parameters:
- *7
- - *301
+ - *298
responses:
'200':
description: Response
content:
application/json:
- schema: *300
+ schema: *297
examples:
- default: *590
+ default: *585
'404':
description: Not Found if project is not managed by this team
x-github:
@@ -85328,7 +84697,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- *7
- - *301
+ - *298
requestBody:
required: false
content:
@@ -85397,7 +84766,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team-legacy
parameters:
- *7
- - *301
+ - *298
responses:
'204':
description: Response
@@ -85467,14 +84836,14 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- *7
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *591
+ schema: *586
examples:
alternative-response-with-extra-repository-information:
value:
@@ -85626,8 +84995,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- *7
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -85678,8 +85047,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- *7
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -85714,9 +85083,9 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
- response-if-child-teams-exist: *592
+ response-if-child-teams-exist: *587
headers:
Link: *6
'404': *26
@@ -85749,7 +85118,7 @@ paths:
application/json:
schema:
oneOf:
- - &594
+ - &589
title: Private User
description: Private User
type: object
@@ -85952,7 +85321,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *593
+ - *588
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -86103,7 +85472,7 @@ paths:
description: Response
content:
application/json:
- schema: *594
+ schema: *589
examples:
default:
value:
@@ -86181,7 +85550,7 @@ paths:
type: array
items: *224
examples:
- default: &604
+ default: &599
value:
- id: 197
name: hello_docker
@@ -86268,7 +85637,7 @@ paths:
application/json:
schema:
type: array
- items: &595
+ items: &590
title: Email
description: Email
type: object
@@ -86293,7 +85662,7 @@ paths:
- verified
- visibility
examples:
- default: &606
+ default: &601
value:
- email: octocat@github.com
verified: true
@@ -86368,7 +85737,7 @@ paths:
application/json:
schema:
type: array
- items: *595
+ items: *590
examples:
default:
value:
@@ -86624,7 +85993,7 @@ paths:
application/json:
schema:
type: array
- items: &596
+ items: &591
title: GPG Key
description: A unique encryption key
type: object
@@ -86755,7 +86124,7 @@ paths:
- subkeys
- revoked
examples:
- default: &616
+ default: &611
value:
- id: 3
name: Octocat's GPG Key
@@ -86840,9 +86209,9 @@ paths:
description: Response
content:
application/json:
- schema: *596
+ schema: *591
examples:
- default: &597
+ default: &592
value:
id: 3
name: Octocat's GPG Key
@@ -86899,7 +86268,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &598
+ - &593
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -86911,9 +86280,9 @@ paths:
description: Response
content:
application/json:
- schema: *596
+ schema: *591
examples:
- default: *597
+ default: *592
'404': *26
'304': *42
'403': *43
@@ -86936,7 +86305,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *598
+ - *593
responses:
'204':
description: Response
@@ -87127,7 +86496,7 @@ paths:
type: array
items: *84
examples:
- default: *599
+ default: *594
headers:
Link: *6
'404': *26
@@ -87303,7 +86672,7 @@ paths:
application/json:
schema:
type: array
- items: &600
+ items: &595
title: Key
description: Key
type: object
@@ -87404,9 +86773,9 @@ paths:
description: Response
content:
application/json:
- schema: *600
+ schema: *595
examples:
- default: &601
+ default: &596
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -87439,15 +86808,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *488
+ - *485
responses:
'200':
description: Response
content:
application/json:
- schema: *600
+ schema: *595
examples:
- default: *601
+ default: *596
'404': *26
'304': *42
'403': *43
@@ -87470,7 +86839,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *488
+ - *485
responses:
'204':
description: Response
@@ -88290,7 +87659,7 @@ paths:
type: array
items: *70
examples:
- default: *602
+ default: *597
headers:
Link: *6
'304': *42
@@ -88332,7 +87701,7 @@ paths:
- docker
- nuget
- container
- - *603
+ - *598
- *5
- *4
responses:
@@ -88344,8 +87713,8 @@ paths:
type: array
items: *224
examples:
- default: *604
- '400': *605
+ default: *599
+ '400': *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -88374,7 +87743,7 @@ paths:
application/json:
schema: *224
examples:
- default: &617
+ default: &612
value:
id: 40201
name: octo-name
@@ -88825,9 +88194,9 @@ paths:
application/json:
schema:
type: array
- items: *595
+ items: *590
examples:
- default: *606
+ default: *601
headers:
Link: *6
'304': *42
@@ -88940,7 +88309,7 @@ paths:
type: array
items: *84
examples:
- default: &613
+ default: &608
summary: Default response
value:
- id: 1296269
@@ -89244,9 +88613,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
+ default: *312
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -89284,9 +88653,9 @@ paths:
application/json:
schema:
type: array
- items: *460
+ items: *457
examples:
- default: *607
+ default: *602
headers:
Link: *6
'304': *42
@@ -89309,7 +88678,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#accept-a-repository-invitation
parameters:
- - *461
+ - *458
responses:
'204':
description: Response
@@ -89332,7 +88701,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#decline-a-repository-invitation
parameters:
- - *461
+ - *458
responses:
'204':
description: Response
@@ -89365,7 +88734,7 @@ paths:
application/json:
schema:
type: array
- items: &608
+ items: &603
title: Social account
description: Social media account
type: object
@@ -89380,7 +88749,7 @@ paths:
- provider
- url
examples:
- default: &609
+ default: &604
value:
- provider: twitter
url: https://twitter.com/github
@@ -89442,9 +88811,9 @@ paths:
application/json:
schema:
type: array
- items: *608
+ items: *603
examples:
- default: *609
+ default: *604
'422': *35
'304': *42
'404': *26
@@ -89531,7 +88900,7 @@ paths:
application/json:
schema:
type: array
- items: &610
+ items: &605
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -89551,7 +88920,7 @@ paths:
- title
- created_at
examples:
- default: &618
+ default: &613
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -89615,9 +88984,9 @@ paths:
description: Response
content:
application/json:
- schema: *610
+ schema: *605
examples:
- default: &611
+ default: &606
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -89647,7 +89016,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &612
+ - &607
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -89659,9 +89028,9 @@ paths:
description: Response
content:
application/json:
- schema: *610
+ schema: *605
examples:
- default: *611
+ default: *606
'404': *26
'304': *42
'403': *43
@@ -89684,7 +89053,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *612
+ - *607
responses:
'204':
description: Response
@@ -89713,7 +89082,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &619
+ - &614
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
@@ -89738,11 +89107,11 @@ paths:
type: array
items: *84
examples:
- default-response: *613
+ default-response: *608
application/vnd.github.v3.star+json:
schema:
type: array
- items: &620
+ items: &615
title: Starred Repository
description: Starred Repository
type: object
@@ -89898,8 +89267,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response if this repository is starred by you
@@ -89927,8 +89296,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -89952,8 +89321,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -90112,10 +89481,10 @@ paths:
application/json:
schema:
oneOf:
- - *594
- - *593
+ - *589
+ - *588
examples:
- default-response: &614
+ default-response: &609
summary: Default response
value:
login: octocat
@@ -90150,7 +89519,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &615
+ response-with-git-hub-plan-information: &610
summary: Response with GitHub plan information
value:
login: octocat
@@ -90262,11 +89631,11 @@ paths:
application/json:
schema:
oneOf:
- - *594
- - *593
+ - *589
+ - *588
examples:
- default-response: *614
- response-with-git-hub-plan-information: *615
+ default-response: *609
+ response-with-git-hub-plan-information: *610
'404': *26
x-github:
githubCloudOnly: false
@@ -90297,7 +89666,7 @@ paths:
type: array
items: *224
examples:
- default: *604
+ default: *599
'403': *43
'401': *41
x-github:
@@ -90710,9 +90079,9 @@ paths:
application/json:
schema:
type: array
- items: *596
+ items: *591
examples:
- default: *616
+ default: *611
headers:
Link: *6
x-github:
@@ -90816,7 +90185,7 @@ paths:
application/json:
schema: *39
examples:
- default: *459
+ default: *456
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90901,7 +90270,7 @@ paths:
type: array
items: *70
examples:
- default: *602
+ default: *597
headers:
Link: *6
x-github:
@@ -90940,7 +90309,7 @@ paths:
- docker
- nuget
- container
- - *603
+ - *598
- *8
- *5
- *4
@@ -90953,10 +90322,10 @@ paths:
type: array
items: *224
examples:
- default: *604
+ default: *599
'403': *43
'401': *41
- '400': *605
+ '400': *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90986,7 +90355,7 @@ paths:
application/json:
schema: *224
examples:
- default: *617
+ default: *612
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91615,9 +90984,9 @@ paths:
application/json:
schema:
type: array
- items: *608
+ items: *603
examples:
- default: *609
+ default: *604
headers:
Link: *6
x-github:
@@ -91647,9 +91016,9 @@ paths:
application/json:
schema:
type: array
- items: *610
+ items: *605
examples:
- default: *618
+ default: *613
headers:
Link: *6
x-github:
@@ -91674,7 +91043,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *8
- - *619
+ - *614
- *9
- *4
- *5
@@ -91686,11 +91055,11 @@ paths:
schema:
anyOf:
- type: array
- items: *620
+ items: *615
- type: array
items: *84
examples:
- default-response: *613
+ default-response: *608
headers:
Link: *6
x-github:
@@ -91900,7 +91269,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &621
+ enterprise: &616
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -91958,7 +91327,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &622
+ installation: &617
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -91977,7 +91346,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &623
+ organization: &618
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -92037,13 +91406,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &624
+ repository: &619
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: &652
+ properties: &647
id:
description: Unique identifier of the repository
example: 42
@@ -92726,7 +92095,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &653
+ required: &648
- archive_url
- assignees_url
- blobs_url
@@ -92877,10 +92246,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -92966,11 +92335,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- rule: &625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ rule: &620
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -93187,11 +92556,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- rule: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ rule: *620
sender: *19
required:
- action
@@ -93365,11 +92734,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- rule: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ rule: *620
sender: *19
required:
- action
@@ -93450,11 +92819,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: &626
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: &621
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -93723,7 +93092,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &627
+ items: &622
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -93841,11 +93210,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
sender: *19
required:
- action
@@ -93925,11 +93294,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
sender: *19
required:
- action
@@ -94009,12 +93378,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
- exemption_response: *627
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
+ exemption_response: *622
sender: *19
required:
- action
@@ -94096,12 +93465,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
- exemption_response: *627
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
+ exemption_response: *622
sender: *19
required:
- action
@@ -94186,12 +93555,12 @@ x-webhooks:
type: string
cache_location:
type: string
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
ref:
type: string
- repository: *624
+ repository: *619
sender: *19
required:
- cache_location
@@ -94285,7 +93654,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &629
+ check_run: &624
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -94338,7 +93707,7 @@ x-webhooks:
type: string
pull_requests:
type: array
- items: *371
+ items: *368
repository: *158
status:
example: completed
@@ -94376,7 +93745,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *628
+ deployment: *623
details_url:
example: https://example.com
type: string
@@ -94426,7 +93795,7 @@ x-webhooks:
- annotations_url
pull_requests:
type: array
- items: *371
+ items: *368
started_at:
example: '2018-05-04T01:14:52Z'
type: string
@@ -94461,10 +93830,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
sender: *19
required:
- check_run
@@ -94867,11 +94236,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *629
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ check_run: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
sender: *19
required:
- check_run
@@ -95277,11 +94646,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *629
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ check_run: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
requested_action:
description: The action requested by the user.
type: object
@@ -95696,11 +95065,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *629
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ check_run: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
sender: *19
required:
- check_run
@@ -96687,10 +96056,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -97394,10 +96763,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -98095,10 +97464,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -98274,7 +97643,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -98419,20 +97788,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &630
+ commit_oid: &625
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: *621
- installation: *622
- organization: *623
- ref: &631
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: &626
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: *624
+ repository: *619
sender: *19
required:
- action
@@ -98607,7 +97976,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -98837,12 +98206,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -98947,7 +98316,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -99118,12 +98487,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -99299,7 +98668,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -99465,12 +98834,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -99579,7 +98948,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -99754,16 +99123,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
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: *624
+ repository: *619
sender: *19
required:
- action
@@ -99870,7 +99239,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -100010,12 +99379,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -100282,10 +99651,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -100375,18 +99744,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *623
- pusher_type: &632
+ organization: *618
+ pusher_type: &627
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &633
+ ref: &628
description: The [`git ref`](https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference)
resource.
type: string
@@ -100396,7 +99765,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *624
+ repository: *619
sender: *19
required:
- ref
@@ -100479,9 +99848,9 @@ x-webhooks:
enum:
- created
definition: *244
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
sender: *19
required:
- action
@@ -100566,9 +99935,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
sender: *19
required:
- action
@@ -100646,9 +100015,9 @@ x-webhooks:
enum:
- updated
definition: *244
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
sender: *19
required:
- action
@@ -100725,10 +100094,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- repository: *624
- organization: *623
+ enterprise: *616
+ installation: *617
+ repository: *619
+ organization: *618
sender: *19
new_property_values:
type: array
@@ -100823,18 +100192,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
- pusher_type: *632
- ref: *633
+ enterprise: *616
+ installation: *617
+ organization: *618
+ pusher_type: *627
+ ref: *628
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *624
+ repository: *619
sender: *19
required:
- ref
@@ -100928,11 +100297,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101026,11 +100395,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101124,11 +100493,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101220,11 +100589,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101316,11 +100685,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101413,11 +100782,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101509,11 +100878,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101600,9 +100969,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- key: &634
+ enterprise: *616
+ installation: *617
+ key: &629
description: The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -101636,8 +101005,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -101724,11 +101093,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- key: *634
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ key: *629
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -102299,12 +101668,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: &638
+ workflow: &633
title: Workflow
type: object
nullable: true
@@ -103040,13 +102409,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *428
+ deployment: *425
pull_requests:
type: array
items: *117
- repository: *624
- organization: *623
- installation: *622
+ repository: *619
+ organization: *618
+ installation: *617
sender: *19
responses:
'200':
@@ -103127,7 +102496,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &635
+ approver: &630
type: object
properties:
avatar_url:
@@ -103170,11 +102539,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- reviewers: &636
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ reviewers: &631
type: array
items:
type: object
@@ -103253,7 +102622,7 @@ x-webhooks:
sender: *19
since:
type: string
- workflow_job_run: &637
+ workflow_job_run: &632
type: object
properties:
conclusion:
@@ -103994,18 +103363,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *635
+ approver: *630
comment:
type: string
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- reviewers: *636
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ reviewers: *631
sender: *19
since:
type: string
- workflow_job_run: *637
+ workflow_job_run: *632
workflow_job_runs:
type: array
items:
@@ -104719,13 +104088,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *621
+ enterprise: *616
environment:
type: string
- installation: *622
- organization: *623
- repository: *624
- requestor: &643
+ installation: *617
+ organization: *618
+ repository: *619
+ requestor: &638
title: User
type: object
nullable: true
@@ -106634,12 +106003,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Deployment Workflow Run
type: object
@@ -107329,7 +106698,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &641
+ answer: &636
type: object
properties:
author_association:
@@ -107486,7 +106855,7 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: &639
+ discussion: &634
title: Discussion
description: A Discussion in a repository.
type: object
@@ -107793,10 +107162,10 @@ x-webhooks:
- updated_at
- active_lock_reason
- body
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -107933,11 +107302,11 @@ x-webhooks:
- from
required:
- category
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108030,11 +107399,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108126,7 +107495,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &640
+ comment: &635
type: object
properties:
author_association:
@@ -108283,11 +107652,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108380,12 +107749,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *640
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ comment: *635
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108490,12 +107859,12 @@ x-webhooks:
- from
required:
- body
- comment: *640
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ comment: *635
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108589,11 +107958,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108685,11 +108054,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108799,11 +108168,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108895,10 +108264,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *639
- enterprise: *621
- installation: *622
- label: &642
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ label: &637
title: Label
type: object
properties:
@@ -108930,8 +108299,8 @@ x-webhooks:
- color
- default
- description
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109024,11 +108393,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109120,11 +108489,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109216,11 +108585,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109315,16 +108684,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *639
- new_repository: *624
+ new_discussion: *634
+ new_repository: *619
required:
- new_discussion
- new_repository
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109417,10 +108786,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *639
- old_answer: *641
- organization: *623
- repository: *624
+ discussion: *634
+ old_answer: *636
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109512,12 +108881,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *639
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109610,11 +108979,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109706,11 +109075,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109951,7 +109320,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *621
+ enterprise: *616
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository)
resource.
@@ -110611,9 +109980,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *622
- organization: *623
- repository: *624
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- forkee
@@ -110779,9 +110148,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pages:
description: The pages that were updated.
type: array
@@ -110818,7 +110187,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *624
+ repository: *619
sender: *19
required:
- pages
@@ -110904,10 +110273,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: &644
+ organization: *618
+ repositories: &639
description: An array of repository objects that the installation
can access.
type: array
@@ -110933,8 +110302,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *624
- requester: *643
+ repository: *619
+ requester: *638
sender: *19
required:
- action
@@ -111019,11 +110388,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -111109,11 +110478,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -111199,10 +110568,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories_added: &645
+ organization: *618
+ repositories_added: &640
description: An array of repository objects, which were added to
the installation.
type: array
@@ -111248,15 +110617,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *624
- repository_selection: &646
+ repository: *619
+ repository_selection: &641
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *643
+ requester: *638
sender: *19
required:
- action
@@ -111345,10 +110714,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories_added: *645
+ organization: *618
+ repositories_added: *640
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -111375,9 +110744,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *624
- repository_selection: *646
- requester: *643
+ repository: *619
+ repository_selection: *641
+ requester: *638
sender: *19
required:
- action
@@ -111466,11 +110835,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -111659,10 +111028,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
target_type:
type: string
@@ -111751,11 +111120,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -112017,8 +111386,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -112812,8 +112181,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -112829,7 +112198,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -113162,8 +112531,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -113253,7 +112622,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &647
+ comment: &642
title: issue comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment)
itself.
@@ -113418,8 +112787,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -114209,8 +113578,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -114226,7 +113595,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -114561,8 +113930,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -114652,7 +114021,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &670
+ changes: &665
description: The changes to the comment.
type: object
properties:
@@ -114664,9 +114033,9 @@ x-webhooks:
type: string
required:
- from
- comment: *647
- enterprise: *621
- installation: *622
+ comment: *642
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -115459,8 +114828,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -115476,7 +114845,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -115809,8 +115178,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -115902,10 +115271,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *643
- enterprise: *621
- installation: *622
- issue: &650
+ assignee: *638
+ enterprise: *616
+ installation: *617
+ issue: &645
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -116694,11 +116063,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -116714,7 +116083,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -116815,8 +116184,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -116906,8 +116275,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -117701,11 +117070,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -117721,7 +117090,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -117957,8 +117326,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -118047,8 +117416,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -118833,11 +118202,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -118853,7 +118222,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -118953,8 +118322,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -119043,8 +118412,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -119851,11 +119220,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -119871,7 +119240,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -119950,7 +119319,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &648
+ milestone: &643
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -120088,8 +119457,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -120198,8 +119567,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -120988,11 +120357,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -121005,7 +120374,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
title:
description: Title of the issue
type: string
@@ -121109,9 +120478,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *642
- organization: *623
- repository: *624
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -121201,8 +120570,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -121990,11 +121359,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -122007,7 +121376,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
title:
description: Title of the issue
type: string
@@ -122111,9 +121480,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *642
- organization: *623
- repository: *624
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -122203,8 +121572,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -123016,11 +122385,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -123033,7 +122402,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
title:
description: Title of the issue
type: string
@@ -123114,8 +122483,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -123204,8 +122573,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -124011,11 +123380,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -124031,7 +123400,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -124109,9 +123478,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *648
- organization: *623
- repository: *624
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -124989,11 +124358,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -125086,7 +124455,7 @@ x-webhooks:
required:
- login
- id
- type: *578
+ type: *575
required:
- id
- number
@@ -125555,8 +124924,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -126345,11 +125714,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126365,7 +125734,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -126465,8 +125834,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -126556,9 +125925,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *621
- installation: *622
- issue: &649
+ enterprise: *616
+ installation: *617
+ issue: &644
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -127341,11 +126710,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -127361,7 +126730,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -127461,8 +126830,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -127551,8 +126920,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -128362,11 +127731,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128460,9 +127829,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- type: *578
- organization: *623
- repository: *624
+ type: *575
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -129338,11 +128707,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129358,7 +128727,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -129926,11 +129295,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *621
- installation: *622
- issue: *649
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *644
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -130021,7 +129390,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &673
+ assignee: &668
title: User
type: object
nullable: true
@@ -130091,11 +129460,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *621
- installation: *622
- issue: *650
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *645
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -130184,12 +129553,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *621
- installation: *622
- issue: *650
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *645
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -130279,8 +129648,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -131090,11 +130459,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131110,7 +130479,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -131188,8 +130557,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131279,11 +130648,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *621
- installation: *622
- issue: *649
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *644
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131372,11 +130741,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131464,11 +130833,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131588,11 +130957,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131706,11 +131075,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131820,11 +131189,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131913,11 +131282,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -132005,11 +131374,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -132085,7 +131454,7 @@ x-webhooks:
required:
- login
- id
- team: &651
+ team: &646
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -132318,11 +131687,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -132399,7 +131768,7 @@ x-webhooks:
required:
- login
- id
- team: *651
+ team: *646
required:
- action
- scope
@@ -132487,7 +131856,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
+ enterprise: *616
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -132596,16 +131965,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *622
- organization: *623
+ installation: *617
+ organization: *618
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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -132696,11 +132065,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
- milestone: *648
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -132789,9 +132158,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- milestone: &654
+ enterprise: *616
+ installation: *617
+ milestone: &649
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -132928,8 +132297,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133018,11 +132387,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- milestone: *648
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133142,11 +132511,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- milestone: *648
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133236,11 +132605,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *621
- installation: *622
- milestone: *654
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *649
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133329,9 +132698,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- membership: &655
+ enterprise: *616
+ installation: *617
+ membership: &650
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -133438,8 +132807,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133527,11 +132896,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *621
- installation: *622
- membership: *655
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ membership: *650
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133620,8 +132989,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -133737,10 +133106,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
- user: *643
+ user: *638
required:
- action
- invitation
@@ -133828,11 +133197,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *621
- installation: *622
- membership: *655
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ membership: *650
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133929,11 +133298,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *621
- installation: *622
- membership: *655
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ membership: *650
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -134019,9 +133388,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
package:
description: Information about the package.
type: object
@@ -134520,7 +133889,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &656
+ items: &651
title: Ruby Gems metadata
type: object
properties:
@@ -134615,7 +133984,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -134701,9 +134070,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
package:
description: Information about the package.
type: object
@@ -135056,7 +134425,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *656
+ items: *651
source_url:
type: string
format: uri
@@ -135126,7 +134495,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -135313,12 +134682,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *621
+ enterprise: *616
id:
type: integer
- installation: *622
- organization: *623
- repository: *624
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- id
@@ -135395,7 +134764,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &657
+ personal_access_token_request: &652
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -135541,10 +134910,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *621
- organization: *623
+ enterprise: *616
+ organization: *618
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135621,11 +134990,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *657
- enterprise: *621
- organization: *623
+ personal_access_token_request: *652
+ enterprise: *616
+ organization: *618
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135701,11 +135070,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *657
- enterprise: *621
- organization: *623
+ personal_access_token_request: *652
+ enterprise: *616
+ organization: *618
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135780,11 +135149,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *657
- organization: *623
- enterprise: *621
+ personal_access_token_request: *652
+ organization: *618
+ enterprise: *616
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135899,7 +135268,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *658
+ last_response: *653
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -135931,8 +135300,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
zen:
description: Random string of GitHub zen.
@@ -136187,10 +135556,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *621
- installation: *622
- organization: *623
- project_card: &659
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_card: &654
title: Project Card
type: object
properties:
@@ -136309,7 +135678,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -136400,11 +135769,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- project_card: *659
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_card: *654
+ repository: *619
sender: *19
required:
- action
@@ -136494,9 +135863,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
project_card:
title: Project Card
type: object
@@ -136624,8 +135993,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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -136729,11 +136098,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *621
- installation: *622
- organization: *623
- project_card: *659
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_card: *654
+ repository: *619
sender: *19
required:
- action
@@ -136837,9 +136206,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
project_card:
allOf:
- title: Project Card
@@ -137029,7 +136398,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -137119,10 +136488,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
- organization: *623
- project: &661
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: &656
title: Project
type: object
properties:
@@ -137246,7 +136615,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -137336,10 +136705,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- project_column: &660
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: &655
title: Project Column
type: object
properties:
@@ -137378,7 +136747,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -137467,18 +136836,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- project_column: *660
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: *655
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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -137578,11 +136947,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- project_column: *660
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: *655
+ repository: *619
sender: *19
required:
- action
@@ -137672,11 +137041,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *621
- installation: *622
- organization: *623
- project_column: *660
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: *655
+ repository: *619
sender: *19
required:
- action
@@ -137766,11 +137135,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
+ repository: *619
sender: *19
required:
- action
@@ -137860,18 +137229,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -137983,11 +137352,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
+ repository: *619
sender: *19
required:
- action
@@ -138076,11 +137445,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
+ repository: *619
sender: *19
required:
- action
@@ -138171,9 +137540,9 @@ x-webhooks:
type: string
enum:
- closed
- installation: *622
- organization: *623
- projects_v2: &662
+ installation: *617
+ organization: *618
+ projects_v2: &657
title: Projects v2 Project
description: A projects v2 project
type: object
@@ -138405,9 +137774,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -138498,9 +137867,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -138627,9 +137996,9 @@ x-webhooks:
type: string
to:
type: string
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -138722,7 +138091,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &666
+ changes: &661
type: object
properties:
archived_at:
@@ -138736,9 +138105,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *622
- organization: *623
- projects_v2_item: &663
+ installation: *617
+ organization: *618
+ projects_v2_item: &658
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -138890,9 +138259,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -138984,9 +138353,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139077,9 +138446,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139195,7 +138564,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &664
+ - &659
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -139217,7 +138586,7 @@ x-webhooks:
required:
- id
- name
- - &665
+ - &660
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -139251,8 +138620,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *664
- - *665
+ - *659
+ - *660
required:
- field_value
- type: object
@@ -139268,9 +138637,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139375,9 +138744,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139470,10 +138839,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *666
- installation: *622
- organization: *623
- projects_v2_item: *663
+ changes: *661
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139565,9 +138934,9 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -139648,10 +139017,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- repository
@@ -139738,13 +139107,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *643
- enterprise: *621
- installation: *622
- number: &667
+ assignee: *638
+ enterprise: *616
+ installation: *617
+ number: &662
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -142027,7 +141396,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -142119,11 +141488,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -144401,7 +143770,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -144493,11 +143862,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -146775,7 +146144,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -146867,11 +146236,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: &668
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: &663
allOf:
- *117
- type: object
@@ -146935,7 +146304,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -147026,12 +146395,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -147121,11 +146490,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *621
- milestone: *491
- number: *667
- organization: *623
- pull_request: &669
+ enterprise: *616
+ milestone: *488
+ number: *662
+ organization: *618
+ pull_request: &664
title: Pull Request
type: object
properties:
@@ -149388,7 +148757,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -149520,12 +148889,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -149615,11 +148984,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *621
- installation: *622
- label: *642
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ label: *637
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -151901,7 +151270,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -151992,10 +151361,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -154275,7 +153644,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -154365,12 +153734,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *621
- milestone: *491
- number: *667
- organization: *623
- pull_request: *669
- repository: *624
+ enterprise: *616
+ milestone: *488
+ number: *662
+ organization: *618
+ pull_request: *664
+ repository: *619
sender: *19
required:
- action
@@ -154459,12 +153828,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -154555,12 +153924,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -154650,12 +154019,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -155031,9 +154400,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
type: object
properties:
@@ -157203,7 +156572,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -157293,7 +156662,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &671
+ comment: &666
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -157578,9 +156947,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
type: object
properties:
@@ -159738,7 +159107,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -159828,11 +159197,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *670
- comment: *671
- enterprise: *621
- installation: *622
- organization: *623
+ changes: *665
+ comment: *666
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
type: object
properties:
@@ -161993,7 +161362,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -162084,9 +161453,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -164259,7 +163628,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
+ repository: *619
review:
description: The review that was affected.
type: object
@@ -164516,9 +163885,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -166572,8 +165941,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
- review: &672
+ repository: *619
+ review: &667
description: The review that was affected.
type: object
properties:
@@ -166816,12 +166185,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -169104,7 +168473,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_reviewer:
title: User
type: object
@@ -169188,12 +168557,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -171483,7 +170852,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -171685,12 +171054,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -173975,7 +173344,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_reviewer:
title: User
type: object
@@ -174060,12 +173429,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -176341,7 +175710,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -176532,9 +175901,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -178709,8 +178078,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
- review: *672
+ repository: *619
+ review: *667
sender: *19
required:
- action
@@ -178800,9 +178169,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -180872,7 +180241,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
thread:
type: object
@@ -181269,9 +180638,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -183327,7 +182696,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
thread:
type: object
@@ -183727,10 +183096,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -186001,7 +185370,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -186093,11 +185462,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *673
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ assignee: *668
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -188380,7 +187749,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -188469,11 +187838,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *621
- installation: *622
- label: *642
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ label: *637
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -190746,7 +190115,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -190837,10 +190206,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -193105,7 +192474,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -193315,7 +192684,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *621
+ enterprise: *616
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -193407,8 +192776,8 @@ x-webhooks:
- url
- author
- committer
- installation: *622
- organization: *623
+ installation: *617
+ organization: *618
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -193993,9 +193362,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
registry_package:
type: object
properties:
@@ -194441,7 +193810,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *656
+ items: *651
summary:
type: string
tag_name:
@@ -194495,7 +193864,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -194583,9 +193952,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
registry_package:
type: object
properties:
@@ -194893,7 +194262,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *656
+ items: *651
summary:
type: string
tag_name:
@@ -194942,7 +194311,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -195029,10 +194398,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- release: &674
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: &669
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -195350,7 +194719,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -195437,11 +194806,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- release: *674
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *669
+ repository: *619
sender: *19
required:
- action
@@ -195568,11 +194937,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *621
- installation: *622
- organization: *623
- release: *674
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *669
+ repository: *619
sender: *19
required:
- action
@@ -195660,9 +195029,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
release:
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
@@ -195984,7 +195353,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -196070,10 +195439,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
- release: &675
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: &670
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -196392,7 +195761,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -196478,11 +195847,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *621
- installation: *622
- organization: *623
- release: *674
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *669
+ repository: *619
sender: *19
required:
- action
@@ -196568,11 +195937,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *621
- installation: *622
- organization: *623
- release: *675
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *670
+ repository: *619
sender: *19
required:
- action
@@ -196658,10 +196027,10 @@ x-webhooks:
type: string
enum:
- anonymous_access_disabled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -196746,10 +196115,10 @@ x-webhooks:
type: string
enum:
- anonymous_access_enabled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -196834,10 +196203,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -196924,10 +196293,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197015,10 +196384,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197112,10 +196481,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197237,10 +196606,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197328,10 +196697,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197418,10 +196787,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197525,10 +196894,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197608,10 +196977,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
repository_ruleset: *273
sender: *19
required:
@@ -197690,10 +197059,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
repository_ruleset: *273
sender: *19
required:
@@ -197772,10 +197141,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
repository_ruleset: *273
changes:
type: object
@@ -197837,16 +197206,16 @@ x-webhooks:
properties:
added:
type: array
- items: *529
+ items: *526
deleted:
type: array
- items: *529
+ items: *526
updated:
type: array
items:
type: object
properties:
- rule: *529
+ rule: *526
changes:
type: object
properties:
@@ -198090,10 +197459,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198181,10 +197550,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198272,7 +197641,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &676
+ alert: &671
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -198393,10 +197762,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198612,10 +197981,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198703,11 +198072,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *676
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *671
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198916,10 +198285,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199007,7 +198376,7 @@ x-webhooks:
type: string
enum:
- created
- alert: &677
+ alert: &672
type: object
properties:
number: *93
@@ -199087,10 +198456,10 @@ x-webhooks:
description: 'The time that push protection was bypassed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
nullable: true
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199181,11 +198550,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *677
- installation: *622
- location: *678
- organization: *623
- repository: *624
+ alert: *672
+ installation: *617
+ location: *673
+ organization: *618
+ repository: *619
sender: *19
required:
- location
@@ -199428,11 +198797,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *677
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *672
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199520,11 +198889,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *677
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *672
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199612,11 +198981,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *677
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *672
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199702,11 +199071,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- security_advisory: &679
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ security_advisory: &674
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -199899,11 +199268,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- security_advisory: *679
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ security_advisory: *674
sender: *19
required:
- action
@@ -199986,10 +199355,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -200184,10 +199553,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *251
- enterprise: *621
- installation: *622
- organization: *623
- repository: *313
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *310
sender: *19
required:
- changes
@@ -200275,12 +199644,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: &680
+ sponsorship: &675
type: object
properties:
created_at:
@@ -200591,12 +199960,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- sponsorship
@@ -200694,12 +200063,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- changes
@@ -200786,17 +200155,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &681
+ effective_date: &676
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: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- sponsorship
@@ -200880,7 +200249,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &682
+ changes: &677
type: object
properties:
tier:
@@ -200924,13 +200293,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *681
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ effective_date: *676
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- changes
@@ -201017,13 +200386,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *682
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ changes: *677
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- changes
@@ -201107,10 +200476,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -201203,10 +200572,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -201632,15 +201001,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *621
+ enterprise: *616
id:
description: The unique identifier of the status.
type: integer
- installation: *622
+ installation: *617
name:
type: string
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
sha:
description: The Commit SHA.
@@ -201752,12 +201121,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- team: &683
+ team: &678
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -201990,9 +201359,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -202450,7 +201819,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -202536,9 +201905,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -202996,7 +202365,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -203083,9 +202452,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -203543,7 +202912,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -203697,9 +203066,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -204157,7 +203526,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- changes
@@ -204245,9 +203614,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -204705,7 +204074,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -204788,12 +204157,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- user: *643
+ user: *638
required:
- action
responses:
@@ -204871,12 +204240,12 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- user: *643
+ user: *638
required:
- action
responses:
@@ -204957,10 +204326,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -205043,16 +204412,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *621
+ enterprise: *616
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *622
- organization: *623
+ installation: *617
+ organization: *618
ref:
type: string
- repository: *624
+ repository: *619
sender: *19
workflow:
type: string
@@ -205144,10 +204513,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
allOf:
@@ -205384,7 +204753,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -205473,10 +204842,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
allOf:
@@ -205736,7 +205105,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -205825,10 +205194,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
type: object
@@ -205963,7 +205332,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -206052,10 +205421,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
type: object
@@ -206191,7 +205560,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -206281,12 +205650,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Workflow Run
type: object
@@ -207295,12 +206664,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Workflow Run
type: object
@@ -208294,12 +207663,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json
index e6537df05..614ab4185 100644
--- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json
+++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.json
@@ -182324,15 +182324,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -182442,8 +182433,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -182485,8 +182474,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -182750,15 +182737,6 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
"created_at": {
"type": "string",
"format": "date-time",
@@ -182868,8 +182846,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -182909,8 +182885,6 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
@@ -183140,14 +183114,406 @@
"example": "0307116bbf7ced493b8d8a346c650b71",
"type": "string"
},
- "comments_count": {
- "type": "integer",
- "example": 0
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-25T18:56:31Z"
},
- "comments_url": {
+ "last_edited_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ },
+ "number": {
+ "description": "The unique sequence number of a team discussion.",
+ "example": 42,
+ "type": "integer"
+ },
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2018-01-25T18:56:31Z"
+ },
+ "url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ },
+ "reactions": {
+ "title": "Reaction Rollup",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "total_count": {
+ "type": "integer"
+ },
+ "+1": {
+ "type": "integer"
+ },
+ "-1": {
+ "type": "integer"
+ },
+ "laugh": {
+ "type": "integer"
+ },
+ "confused": {
+ "type": "integer"
+ },
+ "heart": {
+ "type": "integer"
+ },
+ "hooray": {
+ "type": "integer"
+ },
+ "eyes": {
+ "type": "integer"
+ },
+ "rocket": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "url",
+ "total_count",
+ "+1",
+ "-1",
+ "laugh",
+ "confused",
+ "heart",
+ "hooray",
+ "eyes",
+ "rocket"
+ ]
+ }
+ },
+ "required": [
+ "author",
+ "body",
+ "body_html",
+ "body_version",
+ "created_at",
+ "last_edited_at",
+ "html_url",
+ "pinned",
+ "private",
+ "node_id",
+ "number",
+ "team_url",
+ "title",
+ "updated_at",
+ "url"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "author": {
+ "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
+ },
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
+ "last_edited_at": null,
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
+ "number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
+ "reactions": {
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
+ "total_count": 5,
+ "+1": 3,
+ "-1": 1,
+ "laugh": 0,
+ "confused": 0,
+ "heart": 1,
+ "hooray": 0,
+ "eyes": 1,
+ "rocket": 1
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ },
+ "patch": {
+ "summary": "Update a discussion",
+ "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/update-discussion-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "discussion_number",
+ "description": "The number that identifies the discussion.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
+ "body": {
+ "type": "string",
+ "description": "The discussion post's body text."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "type": "object",
+ "properties": {
+ "author": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
+ "nullable": true
+ },
+ "body": {
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
+ "type": "string"
+ },
+ "body_html": {
+ "type": "string",
+ "example": "Hi! This is an area for us to collaborate as a team
"
+ },
+ "body_version": {
+ "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
+ "example": "0307116bbf7ced493b8d8a346c650b71",
+ "type": "string"
},
"created_at": {
"type": "string",
@@ -183258,8 +183624,6 @@
"body",
"body_html",
"body_version",
- "comments_count",
- "comments_url",
"created_at",
"last_edited_at",
"html_url",
@@ -183299,18 +183663,16 @@
"body": "Hi! This is an area for us to collaborate as a team.",
"body_html": "Hi! This is an area for us to collaborate as a team
",
"body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
"created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
+ "last_edited_at": "2018-01-26T18:22:20Z",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
"node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
"pinned": false,
"private": false,
"team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
+ "title": "Welcome to our first team post",
+ "updated_at": "2018-01-26T18:22:20Z",
"url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
"url": "https://api.github.com/teams/2343027/discussions/1/reactions",
@@ -183338,16 +183700,16 @@
"subcategory": "discussions"
}
},
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "delete": {
+ "summary": "Delete a discussion",
+ "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-in-org",
+ "operationId": "teams/delete-discussion-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion"
},
"parameters": [
{
@@ -183378,27 +183740,185 @@
}
}
],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "discussions"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
+ "get": {
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
"requestBody": {
- "required": false,
+ "required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
}
- }
+ },
+ "required": [
+ "group_id"
+ ]
},
"examples": {
"default": {
"value": {
- "title": "Welcome to our first team post"
+ "group_id": 123
}
}
}
@@ -183411,333 +183931,145 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
"type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
"type": "integer"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
"type": "string"
},
"updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
},
- "eyes": {
- "type": "integer"
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
},
- "rocket": {
- "type": "integer"
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
}
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
}
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
}
}
}
@@ -183746,22 +184078,22 @@
}
},
"x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "external-groups"
}
},
"delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-in-org",
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -183781,15 +184113,6 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -183798,24 +184121,24 @@
}
},
"x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "external-groups"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": {
+ "/orgs/{org}/teams/{team_slug}/members": {
"get": {
- "summary": "List discussion comments",
- "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -183837,26 +184160,18 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
- "asc",
- "desc"
+ "member",
+ "maintainer",
+ "all"
],
- "default": "desc"
+ "default": "all"
}
},
{
@@ -183886,250 +184201,126 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Simple User",
+ "description": "A GitHub user.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "email": {
+ "nullable": true,
"type": "string"
},
- "body_html": {
+ "login": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "octocat"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
},
- "created_at": {
+ "node_id": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "MDQ6VXNlcjE="
},
- "last_edited_at": {
+ "avatar_url": {
"type": "string",
- "format": "date-time",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
- "discussion_url": {
+ "url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
+ "example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/octocat"
},
- "node_id": {
+ "followers_url": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
},
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
},
- "updated_at": {
+ "gists_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
- "url": {
+ "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/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/users/octocat/subscriptions"
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "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": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
"html_url",
+ "id",
"node_id",
- "number",
- "updated_at",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
"url"
]
}
@@ -184138,49 +184329,24 @@
"default": {
"value": [
{
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "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
}
]
}
@@ -184201,19 +184367,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion comment",
- "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -184235,35 +184403,141 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "if user has no team membership"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "body": "Do you like apples?"
+ "role": "maintainer"
}
}
}
@@ -184271,331 +184545,138 @@
}
},
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
- "type": "string"
- },
- "body_html": {
+ "url": {
"type": "string",
- "example": "Do you like apples?
"
+ "format": "uri"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
- "author": {
- "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
- },
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ },
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/orgs/{org}/teams/{team_slug}/projects": {
"get": {
- "summary": "Get a discussion comment",
- "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List team projects",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-in-org",
+ "operationId": "teams/list-projects-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects"
},
"parameters": [
{
@@ -184617,17 +184698,347 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Team Project",
+ "description": "A team's access to a project.",
+ "type": "object",
+ "properties": {
+ "owner_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "columns_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
+ "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"
+ ]
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "updated_at": {
+ "type": "string"
+ },
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
+ },
+ "private": {
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "type": "boolean"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "read": {
+ "type": "boolean"
+ },
+ "write": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
+ },
+ "required": [
+ "owner_url",
+ "url",
+ "html_url",
+ "columns_url",
+ "id",
+ "node_id",
+ "name",
+ "body",
+ "number",
+ "state",
+ "creator",
+ "created_at",
+ "updated_at",
+ "permissions"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
+ "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
+ },
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": false,
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
+ "get": {
+ "summary": "Check team permissions for a project",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/check-permissions-for-project-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -184641,11 +185052,42 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Project",
+ "description": "A team's access to a project.",
"type": "object",
"properties": {
- "author": {
+ "owner_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "columns_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -184767,131 +185209,73 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "created_at": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "updated_at": {
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "private": {
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "type": "boolean"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "permissions": {
"type": "object",
"properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
+ "read": {
+ "type": "boolean"
},
- "eyes": {
- "type": "integer"
+ "write": {
+ "type": "boolean"
},
- "rocket": {
- "type": "integer"
+ "admin": {
+ "type": "boolean"
}
},
"required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "read",
+ "write",
+ "admin"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
+ "owner_url",
+ "url",
"html_url",
+ "columns_url",
+ "id",
"node_id",
+ "name",
+ "body",
"number",
+ "state",
+ "creator",
+ "created_at",
"updated_at",
- "url"
+ "permissions"
]
},
"examples": {
"default": {
"value": {
- "author": {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -184911,53 +185295,45 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
+ "private": false,
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
}
}
}
}
}
}
+ },
+ "404": {
+ "description": "Not Found if project is not managed by this team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
- "patch": {
- "summary": "Update a discussion comment",
- "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team project permissions",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-in-org",
+ "operationId": "teams/add-or-update-project-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
},
"parameters": [
{
@@ -184979,17 +185355,8 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -184998,25 +185365,29 @@
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "body": {
+ "permission": {
"type": "string",
- "description": "The discussion comment's body text."
- }
+ "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
+ }
},
- "required": [
- "body"
- ]
+ "nullable": true
},
"examples": {
"default": {
+ "summary": "Updates the permissions for the team to write for the project",
"value": {
- "body": "Do you like pineapples?"
+ "permission": "write"
}
}
}
@@ -185024,304 +185395,29 @@
}
},
"responses": {
- "200": {
- "description": "Response",
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if the project is not owned by the organization",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "message": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Do you like apples?
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "documentation_url": {
"type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
- },
- "number": {
- "description": "The unique sequence number of a team discussion comment.",
- "example": 42,
- "type": "integer"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-15T23:53:58Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
}
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "discussion_url",
- "html_url",
- "node_id",
- "number",
- "updated_at",
- "url"
- ]
+ }
},
"examples": {
- "default": {
+ "response-if-the-project-is-not-owned-by-the-organization": {
"value": {
- "author": {
- "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
- },
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
- "number": 1,
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
- "reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "message": "Must have admin rights to Repository.",
+ "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
}
}
}
@@ -185333,19 +185429,22 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment",
- "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove a project from a team",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-in-org",
+ "operationId": "teams/remove-project-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team"
},
"parameters": [
{
@@ -185367,17 +185466,8 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -185394,396 +185484,24 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussion-comments"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/external-groups": {
- "get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
},
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
+ "deprecated": true
}
},
- "/orgs/{org}/teams/{team_slug}/members": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-members-in-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
},
"parameters": [
{
@@ -185804,21 +185522,6 @@
"type": "string"
}
},
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
{
"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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
@@ -185846,737 +185549,642 @@
"schema": {
"type": "array",
"items": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
"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
+ "example": 1296269
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
- "avatar_url": {
+ "name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ },
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
+ "example": "https://github.com/octocat/Hello-World"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "This your first repo!",
"nullable": true
},
+ "fork": {
+ "type": "boolean"
+ },
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/repos/octocat/Hello-World"
},
- "html_url": {
+ "archive_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
- "followers_url": {
+ "assignees_url": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
- "following_url": {
+ "blobs_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
- "gists_url": {
+ "branches_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
- "starred_url": {
+ "collaborators_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
- "subscriptions_url": {
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
- "organizations_url": {
+ "deployments_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
- "repos_url": {
+ "downloads_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
},
- "received_events_url": {
+ "forks_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
- "type": {
+ "git_commits_url": {
"type": "string",
- "example": "User"
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
- "site_admin": {
- "type": "boolean"
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
- "starred_at": {
+ "git_tags_url": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
- "user_view_type": {
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
"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"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "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
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- },
- "422": {
- "description": "Unprocessable Entity if you attempt to add an organization to a team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "delete": {
- "summary": "Remove team membership for a user",
- "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/remove-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/projects": {
- "get": {
- "summary": "List team projects",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-projects-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Project",
- "description": "A team's access to a project.",
- "type": "object",
- "properties": {
- "owner_url": {
- "type": "string"
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
- "url": {
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
"type": "string"
},
- "html_url": {
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
"type": "string"
},
- "columns_url": {
+ "mirror_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
"type": "string"
},
- "id": {
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
"type": "integer"
},
- "node_id": {
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer"
+ },
+ "default_branch": {
"type": "string"
},
- "name": {
+ "open_issues_count": {
+ "type": "integer"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "type": "boolean"
+ },
+ "has_projects": {
+ "type": "boolean"
+ },
+ "has_wiki": {
+ "type": "boolean"
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "type": "boolean"
+ },
+ "has_discussions": {
+ "type": "boolean"
+ },
+ "archived": {
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean"
+ },
+ "visibility": {
"type": "string"
},
- "body": {
+ "pushed_at": {
"type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
"nullable": true
},
- "number": {
- "type": "integer"
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
},
- "state": {
- "type": "string"
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "permissions": {
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
+ "admin": {
+ "type": "boolean"
},
- "login": {
- "type": "string",
- "example": "octocat"
+ "maintain": {
+ "type": "boolean"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "push": {
+ "type": "boolean"
},
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
+ "triage": {
+ "type": "boolean"
},
- "avatar_url": {
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "code_of_conduct": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
+ "example": "contributor_covenant"
},
- "gravatar_id": {
+ "name": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "Contributor Covenant"
},
"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"
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
},
- "events_url": {
+ "body": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
},
- "received_events_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
},
- "type": {
- "type": "string",
- "example": "User"
+ "name": {
+ "type": "string"
},
- "site_admin": {
- "type": "boolean"
+ "spdx_id": {
+ "type": "string"
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "url": {
+ "type": "string"
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "node_id": {
+ "type": "string"
}
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
+ "nullable": true
},
- "created_at": {
- "type": "string"
+ "forks": {
+ "type": "integer",
+ "example": 0
},
- "updated_at": {
- "type": "string"
+ "open_issues": {
+ "type": "integer",
+ "example": 0
},
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
- "type": "string"
+ "watchers": {
+ "type": "integer",
+ "example": 0
},
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
+ "allow_forking": {
"type": "boolean"
},
- "permissions": {
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "security_and_analysis": {
+ "nullable": true,
"type": "object",
"properties": {
- "read": {
- "type": "boolean"
+ "advanced_security": {
+ "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
},
- "write": {
- "type": "boolean"
+ "dependabot_security_updates": {
+ "description": "Enable or disable Dependabot security updates for the repository.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The enablement status of Dependabot security updates for the repository.",
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
},
- "admin": {
- "type": "boolean"
+ "secret_scanning": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_push_protection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
}
- },
- "required": [
- "read",
- "write",
- "admin"
- ]
+ }
}
},
"required": [
- "owner_url",
- "url",
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
"html_url",
- "columns_url",
"id",
"node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
"name",
- "body",
- "number",
- "state",
- "creator",
- "created_at",
- "updated_at",
- "permissions"
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url"
]
}
},
@@ -186584,17 +186192,11 @@
"default": {
"value": [
{
- "owner_url": "https://api.github.com/orgs/octocat",
- "url": "https://api.github.com/projects/1002605",
- "html_url": "https://github.com/orgs/api-playground/projects/1",
- "columns_url": "https://api.github.com/projects/1002605/columns",
- "id": 1002605,
- "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year.",
- "number": 1,
- "state": "open",
- "creator": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -186614,14 +186216,94 @@
"type": "User",
"site_admin": false
},
- "created_at": "2011-04-11T20:09:31Z",
- "updated_at": "2014-03-04T18:58:10Z",
- "organization_permission": "write",
"private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "has_discussions": false,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
"permissions": {
- "read": true,
- "write": true,
- "admin": false
+ "admin": false,
+ "push": false,
+ "pull": true
+ },
+ "security_and_analysis": {
+ "advanced_security": {
+ "status": "enabled"
+ },
+ "secret_scanning": {
+ "status": "enabled"
+ },
+ "secret_scanning_push_protection": {
+ "status": "disabled"
+ }
}
}
]
@@ -186643,24 +186325,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
}
},
- "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
+ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
"get": {
- "summary": "Check team permissions for a project",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "summary": "Check team permissions for a repository",
+ "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
"tags": [
"teams"
],
- "operationId": "teams/check-permissions-for-project-in-org",
+ "operationId": "teams/check-permissions-for-repo-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository"
},
"parameters": [
{
@@ -186682,64 +186361,134 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
"responses": {
"200": {
- "description": "Response",
+ "description": "Alternative response with repository permissions",
"content": {
"application/json": {
"schema": {
- "title": "Team Project",
- "description": "A team's access to a project.",
+ "title": "Team Repository",
+ "description": "A team's access to a repository.",
"type": "object",
"properties": {
- "owner_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "html_url": {
- "type": "string"
- },
- "columns_url": {
- "type": "string"
- },
"id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
"type": "integer"
},
"node_id": {
- "type": "string"
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"name": {
- "type": "string"
- },
- "body": {
+ "description": "The name of the repository.",
"type": "string",
- "nullable": true
- },
- "number": {
- "type": "integer"
+ "example": "Team Environment"
},
- "state": {
- "type": "string"
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "license": {
+ "title": "License Simple",
+ "description": "License Simple",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
"email": {
"nullable": true,
@@ -186854,73 +186603,463 @@
"subscriptions_url",
"type",
"url"
- ]
+ ],
+ "nullable": true
},
- "created_at": {
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
"type": "string"
},
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
"updated_at": {
- "type": "string"
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
},
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
"type": "string"
},
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
- "type": "boolean"
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
},
- "permissions": {
- "type": "object",
- "properties": {
- "read": {
- "type": "boolean"
- },
- "write": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "read",
- "write",
- "admin"
- ]
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
}
},
"required": [
- "owner_url",
- "url",
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
"html_url",
- "columns_url",
"id",
"node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
"name",
- "body",
- "number",
- "state",
- "creator",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
"created_at",
- "updated_at",
- "permissions"
+ "updated_at"
]
},
"examples": {
- "default": {
+ "alternative-response-with-repository-permissions": {
"value": {
- "owner_url": "https://api.github.com/orgs/octocat",
- "url": "https://api.github.com/projects/1002605",
- "html_url": "https://github.com/orgs/api-playground/projects/1",
- "columns_url": "https://api.github.com/projects/1002605/columns",
- "id": 1002605,
- "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year.",
- "number": 1,
- "state": "open",
- "creator": {
+ "id": 1296269,
+ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
+ "name": "Hello-World",
+ "full_name": "octocat/Hello-World",
+ "owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -186940,45 +187079,135 @@
"type": "User",
"site_admin": false
},
- "created_at": "2011-04-11T20:09:31Z",
- "updated_at": "2014-03-04T18:58:10Z",
- "organization_permission": "write",
"private": false,
+ "html_url": "https://github.com/octocat/Hello-World",
+ "description": "This your first repo!",
+ "fork": false,
+ "url": "https://api.github.com/repos/octocat/Hello-World",
+ "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
+ "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
+ "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
+ "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
+ "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
+ "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
+ "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
+ "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
+ "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
+ "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
+ "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
+ "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
+ "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
+ "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
+ "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
+ "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
+ "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
+ "git_url": "git:github.com/octocat/Hello-World.git",
+ "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
+ "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
+ "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
+ "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
+ "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
+ "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
+ "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
+ "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
+ "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
+ "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
+ "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
+ "ssh_url": "git@github.com:octocat/Hello-World.git",
+ "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
+ "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
+ "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
+ "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
+ "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
+ "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
+ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
+ "clone_url": "https://github.com/octocat/Hello-World.git",
+ "mirror_url": "git:git.example.com/octocat/Hello-World",
+ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
+ "svn_url": "https://svn.github.com/octocat/Hello-World",
+ "homepage": "https://github.com",
+ "language": null,
+ "forks_count": 9,
+ "stargazers_count": 80,
+ "watchers_count": 80,
+ "size": 108,
+ "default_branch": "master",
+ "open_issues_count": 0,
+ "is_template": false,
+ "topics": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ],
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true,
+ "has_pages": false,
+ "has_downloads": true,
+ "archived": false,
+ "disabled": false,
+ "visibility": "public",
+ "pushed_at": "2011-01-26T19:06:43Z",
+ "created_at": "2011-01-26T19:01:12Z",
+ "updated_at": "2011-01-26T19:14:43Z",
"permissions": {
- "read": true,
- "write": true,
- "admin": false
- }
+ "admin": false,
+ "maintain": false,
+ "push": false,
+ "triage": false,
+ "pull": true
+ },
+ "role_name": "read",
+ "allow_rebase_merge": true,
+ "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
+ "allow_squash_merge": true,
+ "allow_auto_merge": false,
+ "delete_branch_on_merge": true,
+ "allow_merge_commit": true,
+ "subscribers_count": 42,
+ "network_count": 0,
+ "license": {
+ "key": "mit",
+ "name": "MIT License",
+ "url": "https://api.github.com/licenses/mit",
+ "spdx_id": "MIT",
+ "node_id": "MDc6TGljZW5zZW1pdA==",
+ "html_url": "https://api.github.com/licenses/mit"
+ },
+ "forks": 1,
+ "open_issues": 1,
+ "watchers": 1
}
}
}
}
}
},
+ "204": {
+ "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
+ },
"404": {
- "description": "Not Found if project is not managed by this team"
+ "description": "Not Found if team does not have permission for the repository"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
},
"put": {
- "summary": "Add or update team project permissions",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "summary": "Add or update team repository permissions",
+ "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
"tags": [
"teams"
],
- "operationId": "teams/add-or-update-project-permissions-in-org",
+ "operationId": "teams/add-or-update-repo-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions"
},
"parameters": [
{
@@ -187000,12 +187229,21 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
@@ -187018,21 +187256,15 @@
"properties": {
"permission": {
"type": "string",
- "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"",
- "enum": [
- "read",
- "write",
- "admin"
- ]
+ "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."
}
- },
- "nullable": true
+ }
},
"examples": {
"default": {
- "summary": "Updates the permissions for the team to write for the project",
+ "summary": "Adding a team to an organization repository with the write role",
"value": {
- "permission": "write"
+ "permission": "push"
}
}
}
@@ -187042,54 +187274,25 @@
"responses": {
"204": {
"description": "Response"
- },
- "403": {
- "description": "Forbidden if the project is not owned by the organization",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- },
- "examples": {
- "response-if-the-project-is-not-owned-by-the-organization": {
- "value": {
- "message": "Must have admin rights to Repository.",
- "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
- }
- }
- }
- }
- }
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
},
"delete": {
- "summary": "Remove a project from a team",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "summary": "Remove a repository from a team",
+ "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
"tags": [
"teams"
],
- "operationId": "teams/remove-project-in-org",
+ "operationId": "teams/remove-repo-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team"
},
"parameters": [
{
@@ -187111,12 +187314,21 @@
}
},
{
- "name": "project_id",
- "description": "The unique identifier of the project.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
}
],
@@ -187129,24 +187341,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
+ "subcategory": "teams"
+ }
}
},
- "/orgs/{org}/teams/{team_slug}/repos": {
+ "/orgs/{org}/teams/{team_slug}/teams": {
"get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
+ "summary": "List child teams",
+ "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
"tags": [
"teams"
],
- "operationId": "teams/list-repos-in-org",
+ "operationId": "teams/list-child-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams"
},
"parameters": [
{
@@ -187188,768 +187397,252 @@
],
"responses": {
"200": {
- "description": "Response",
+ "description": "if child teams exist",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
+ "type": "integer"
},
"node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ "type": "string"
},
"name": {
- "type": "string",
- "example": "Hello-World"
+ "type": "string"
},
- "full_name": {
+ "slug": {
+ "type": "string"
+ },
+ "description": {
"type": "string",
- "example": "octocat/Hello-World"
+ "nullable": true
},
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "pull": {
+ "type": "boolean"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "triage": {
+ "type": "boolean"
},
- "login": {
- "type": "string",
- "example": "octocat"
+ "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"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
+ },
+ "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",
- "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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
+ ],
"nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
- "type": "string"
- },
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- },
- "clone_url": {
- "type": "string"
- },
- "mirror_url": {
- "type": "string",
- "nullable": true
- },
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
- "type": "string"
- },
- "homepage": {
- "type": "string",
- "nullable": true
- },
- "language": {
- "type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer"
- },
- "stargazers_count": {
- "type": "integer"
- },
- "watchers_count": {
- "type": "integer"
- },
- "size": {
- "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
- "type": "integer"
- },
- "default_branch": {
- "type": "string"
- },
- "open_issues_count": {
- "type": "integer"
- },
- "is_template": {
- "type": "boolean"
- },
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "has_issues": {
- "type": "boolean"
- },
- "has_projects": {
- "type": "boolean"
- },
- "has_wiki": {
- "type": "boolean"
- },
- "has_pages": {
- "type": "boolean"
- },
- "has_downloads": {
- "type": "boolean"
- },
- "has_discussions": {
- "type": "boolean"
- },
- "archived": {
- "type": "boolean"
- },
- "disabled": {
- "type": "boolean"
- },
- "visibility": {
- "type": "string"
- },
- "pushed_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- }
- },
- "role_name": {
- "type": "string",
- "example": "admin"
- },
- "temp_clone_token": {
- "type": "string"
- },
- "delete_branch_on_merge": {
- "type": "boolean"
- },
- "subscribers_count": {
- "type": "integer"
- },
- "network_count": {
- "type": "integer"
- },
- "code_of_conduct": {
- "title": "Code Of Conduct",
- "description": "Code Of Conduct",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "contributor_covenant"
- },
- "name": {
- "type": "string",
- "example": "Contributor Covenant"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
- },
- "body": {
- "type": "string",
- "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "nullable": true
- }
- },
- "required": [
- "url",
- "html_url",
- "key",
- "name"
- ]
- },
- "license": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "spdx_id": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "node_id": {
- "type": "string"
- }
- },
- "nullable": true
- },
- "forks": {
- "type": "integer",
- "example": 0
- },
- "open_issues": {
- "type": "integer",
- "example": 0
- },
- "watchers": {
- "type": "integer",
- "example": 0
- },
- "allow_forking": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "security_and_analysis": {
- "nullable": true,
- "type": "object",
- "properties": {
- "advanced_security": {
- "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- },
- "dependabot_security_updates": {
- "description": "Enable or disable Dependabot security updates for the repository.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The enablement status of Dependabot security updates for the repository.",
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- },
- "secret_scanning": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- },
- "secret_scanning_push_protection": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
- }
- }
}
},
"required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
"id",
"node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
+ "url",
+ "members_url",
"name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url"
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent",
+ "type"
]
}
},
"examples": {
- "default": {
+ "response-if-child-teams-exist": {
"value": [
{
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "login": "octocat",
+ "id": 2,
+ "node_id": "MDQ6VGVhbTI=",
+ "url": "https://api.github.com/teams/2",
+ "name": "Original Roster",
+ "slug": "original-roster",
+ "description": "Started it all.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/2/members{/member}",
+ "repositories_url": "https://api.github.com/teams/2/repos",
+ "parent": {
"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
- },
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
- "has_discussions": false,
- "archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "push": false,
- "pull": true
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos"
},
- "security_and_analysis": {
- "advanced_security": {
- "status": "enabled"
- },
- "secret_scanning": {
- "status": "enabled"
- },
- "secret_scanning_push_protection": {
- "status": "disabled"
- }
- }
+ "html_url": "https://github.com/orgs/rails/teams/core"
}
]
}
@@ -187974,17 +187667,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
- "get": {
- "summary": "Check team permissions for a repository",
- "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
+ "/orgs/{org}/{security_product}/{enablement}": {
+ "post": {
+ "summary": "Enable or disable a security feature for an organization",
+ "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.",
"tags": [
- "teams"
+ "orgs"
],
- "operationId": "teams/check-permissions-for-repo-in-org",
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
},
"parameters": [
{
@@ -187997,136 +187690,135 @@
}
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "name": "security_product",
"in": "path",
+ "description": "The security feature to enable or disable.",
"required": true,
"schema": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "dependency_graph",
+ "dependabot_alerts",
+ "dependabot_security_updates",
+ "advanced_security",
+ "code_scanning_default_setup",
+ "secret_scanning",
+ "secret_scanning_push_protection"
+ ]
}
},
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "enablement",
"in": "path",
+ "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.",
"required": true,
"schema": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "enable_all",
+ "disable_all"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "query_suite": {
+ "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.",
+ "type": "string",
+ "enum": [
+ "default",
+ "extended"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
}
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Action started"
},
+ "422": {
+ "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "orgs",
+ "subcategory": "orgs",
+ "deprecationDate": "2024-07-22",
+ "removalDate": "2025-07-22"
+ },
+ "deprecated": true
+ }
+ },
+ "/projects/columns/cards/{card_id}": {
+ "get": {
+ "summary": "Get a project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "projects-classic"
+ ],
+ "operationId": "projects-classic/get-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card"
+ },
+ "parameters": [
{
- "name": "repo",
- "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer"
}
}
],
"responses": {
"200": {
- "description": "Alternative response with repository permissions",
+ "description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Repository",
- "description": "A team's access to a repository.",
+ "title": "Project Card",
+ "description": "Project cards represent a scope of work.",
"type": "object",
"properties": {
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/cards/1478"
+ },
"id": {
- "description": "Unique identifier of the repository",
+ "description": "The project card's ID",
"example": 42,
- "type": "integer"
+ "type": "integer",
+ "format": "int64"
},
"node_id": {
"type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "description": "The name of the repository.",
- "type": "string",
- "example": "Team Environment"
+ "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
},
- "full_name": {
+ "note": {
"type": "string",
- "example": "octocat/Hello-World"
- },
- "license": {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "mit"
- },
- "name": {
- "type": "string",
- "example": "MIT License"
- },
- "url": {
- "type": "string",
- "nullable": true,
- "format": "uri",
- "example": "https://api.github.com/licenses/mit"
- },
- "spdx_id": {
- "type": "string",
- "nullable": true,
- "example": "MIT"
- },
- "node_id": {
- "type": "string",
- "example": "MDc6TGljZW5zZW1pdA=="
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ],
+ "example": "Add payload for delete Project column",
"nullable": true
},
- "forks": {
- "type": "integer"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "role_name": {
- "type": "string",
- "example": "admin"
- },
- "owner": {
+ "creator": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -188251,460 +187943,451 @@
],
"nullable": true
},
- "private": {
- "description": "Whether the repository is private or public.",
- "default": false,
- "type": "boolean"
- },
- "html_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
+ "format": "date-time",
+ "example": "2016-09-05T14:21:06Z"
},
- "description": {
+ "updated_at": {
"type": "string",
- "example": "This your first repo!",
- "nullable": true
+ "format": "date-time",
+ "example": "2016-09-05T14:20:22Z"
},
- "fork": {
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "example": false,
"type": "boolean"
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ "column_name": {
+ "type": "string"
},
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ "project_id": {
+ "type": "string"
},
- "downloads_url": {
+ "column_url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ "example": "https://api.github.com/projects/columns/367"
},
- "events_url": {
+ "content_url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
},
- "forks_url": {
+ "project_url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ "example": "https://api.github.com/projects/120"
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "note",
+ "url",
+ "column_url",
+ "project_url",
+ "creator",
+ "created_at",
+ "updated_at"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "url": "https://api.github.com/projects/columns/cards/1478",
+ "id": 1478,
+ "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
+ "note": "Add payload for delete Project column",
+ "creator": {
+ "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
+ },
+ "created_at": "2016-09-05T14:21:06Z",
+ "updated_at": "2016-09-05T14:20:22Z",
+ "archived": false,
+ "column_url": "https://api.github.com/projects/columns/367",
+ "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
+ "project_url": "https://api.github.com/projects/120"
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
},
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ "documentation_url": {
+ "type": "string"
},
- "git_url": {
- "type": "string",
- "example": "git:github.com/octocat/Hello-World.git"
+ "url": {
+ "type": "string"
},
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
},
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ "documentation_url": {
+ "type": "string"
},
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ "url": {
+ "type": "string"
},
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string",
- "example": "git@github.com:octocat/Hello-World.git"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
},
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ "documentation_url": {
+ "type": "string"
},
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ "url": {
+ "type": "string"
},
- "teams_url": {
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
+ },
+ "patch": {
+ "summary": "Update an existing project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "projects-classic"
+ ],
+ "operationId": "projects-classic/update-card",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card"
+ },
+ "parameters": [
+ {
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "note": {
+ "description": "The project card's note",
+ "example": "Update all gems",
+ "type": "string",
+ "nullable": true
+ },
+ "archived": {
+ "description": "Whether or not the card is archived",
+ "example": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Change the note on the card",
+ "value": {
+ "note": "Add payload for delete Project column"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Project Card",
+ "description": "Project cards represent a scope of work.",
+ "type": "object",
+ "properties": {
+ "url": {
"type": "string",
"format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ "example": "https://api.github.com/projects/columns/cards/1478"
},
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ "id": {
+ "description": "The project card's ID",
+ "example": 42,
+ "type": "integer",
+ "format": "int64"
},
- "clone_url": {
+ "node_id": {
"type": "string",
- "example": "https://github.com/octocat/Hello-World.git"
+ "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
},
- "mirror_url": {
+ "note": {
"type": "string",
- "format": "uri",
- "example": "git:git.example.com/octocat/Hello-World",
+ "example": "Add payload for delete Project column",
"nullable": true
},
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
- "type": "string",
- "format": "uri",
- "example": "https://svn.github.com/octocat/Hello-World"
- },
- "homepage": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com",
+ "creator": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
"nullable": true
},
- "language": {
+ "created_at": {
"type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer",
- "example": 9
- },
- "stargazers_count": {
- "type": "integer",
- "example": 80
- },
- "watchers_count": {
- "type": "integer",
- "example": 80
- },
- "size": {
- "type": "integer",
- "example": 108
+ "format": "date-time",
+ "example": "2016-09-05T14:21:06Z"
},
- "default_branch": {
- "description": "The default branch of the repository.",
+ "updated_at": {
"type": "string",
- "example": "master"
- },
- "open_issues_count": {
- "type": "integer",
- "example": 0
- },
- "is_template": {
- "description": "Whether this repository acts as a template that can be used to generate new repositories.",
- "default": false,
- "type": "boolean",
- "example": true
- },
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "has_issues": {
- "description": "Whether issues are enabled.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "has_projects": {
- "description": "Whether projects are enabled.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "has_wiki": {
- "description": "Whether the wiki is enabled.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "has_pages": {
- "type": "boolean"
- },
- "has_downloads": {
- "description": "Whether downloads are enabled.",
- "default": true,
- "type": "boolean",
- "example": true
+ "format": "date-time",
+ "example": "2016-09-05T14:20:22Z"
},
"archived": {
- "description": "Whether the repository is archived.",
- "default": false,
+ "description": "Whether or not the card is archived",
+ "example": false,
"type": "boolean"
},
- "disabled": {
- "type": "boolean",
- "description": "Returns whether or not this repository disabled."
+ "column_name": {
+ "type": "string"
},
- "visibility": {
- "description": "The repository visibility: public, private, or internal.",
- "default": "public",
+ "project_id": {
"type": "string"
},
- "pushed_at": {
+ "column_url": {
"type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367"
},
- "created_at": {
+ "content_url": {
"type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
+ "format": "uri",
+ "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
},
- "updated_at": {
+ "project_url": {
"type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
- "allow_rebase_merge": {
- "description": "Whether to allow rebase merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "temp_clone_token": {
- "type": "string"
- },
- "allow_squash_merge": {
- "description": "Whether to allow squash merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_auto_merge": {
- "description": "Whether to allow Auto-merge to be used on pull requests.",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "delete_branch_on_merge": {
- "description": "Whether to delete head branches when pull requests are merged",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "allow_merge_commit": {
- "description": "Whether to allow merge commits for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_forking": {
- "description": "Whether to allow forking this repo",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "web_commit_signoff_required": {
- "description": "Whether to require contributors to sign off on web-based commits",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "subscribers_count": {
- "type": "integer"
- },
- "network_count": {
- "type": "integer"
- },
- "open_issues": {
- "type": "integer"
- },
- "watchers": {
- "type": "integer"
- },
- "master_branch": {
- "type": "string"
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
}
},
"required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
"id",
"node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
+ "note",
"url",
- "clone_url",
- "default_branch",
- "forks",
- "forks_count",
- "git_url",
- "has_downloads",
- "has_issues",
- "has_projects",
- "has_wiki",
- "has_pages",
- "homepage",
- "language",
- "archived",
- "disabled",
- "mirror_url",
- "open_issues",
- "open_issues_count",
- "license",
- "pushed_at",
- "size",
- "ssh_url",
- "stargazers_count",
- "svn_url",
- "watchers",
- "watchers_count",
+ "column_url",
+ "project_url",
+ "creator",
"created_at",
"updated_at"
]
},
"examples": {
- "alternative-response-with-repository-permissions": {
+ "default": {
"value": {
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
+ "url": "https://api.github.com/projects/columns/cards/1478",
+ "id": 1478,
+ "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
+ "note": "Add payload for delete Project column",
+ "creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -188724,708 +188407,532 @@
"type": "User",
"site_admin": false
},
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
+ "created_at": "2016-09-05T14:21:06Z",
+ "updated_at": "2016-09-05T14:20:22Z",
"archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "maintain": false,
- "push": false,
- "triage": false,
- "pull": true
- },
- "role_name": "read",
- "allow_rebase_merge": true,
- "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
- "allow_squash_merge": true,
- "allow_auto_merge": false,
- "delete_branch_on_merge": true,
- "allow_merge_commit": true,
- "subscribers_count": 42,
- "network_count": 0,
- "license": {
- "key": "mit",
- "name": "MIT License",
- "url": "https://api.github.com/licenses/mit",
- "spdx_id": "MIT",
- "node_id": "MDc6TGljZW5zZW1pdA==",
- "html_url": "https://api.github.com/licenses/mit"
- },
- "forks": 1,
- "open_issues": 1,
- "watchers": 1
+ "column_url": "https://api.github.com/projects/columns/367",
+ "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
+ "project_url": "https://api.github.com/projects/120"
}
}
}
}
}
},
- "204": {
- "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
- },
- "404": {
- "description": "Not Found if team does not have permission for the repository"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- },
- "put": {
- "summary": "Add or update team repository permissions",
- "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-repo-permissions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
+ "304": {
+ "description": "Not modified"
},
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
},
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
},
- {
- "name": "repo",
- "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."
+ "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"
+ }
}
}
- },
- "examples": {
- "default": {
- "summary": "Adding a team to an organization repository with the write role",
- "value": {
- "permission": "push"
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error Simple",
+ "description": "Validation Error Simple",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
}
}
}
}
}
},
- "responses": {
- "204": {
- "description": "Response"
- }
- },
"x-github": {
- "githubCloudOnly": false,
+ "githubCloudOnly": true,
"enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
"delete": {
- "summary": "Remove a repository from a team",
- "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.",
+ "summary": "Delete a project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
- "teams"
+ "projects-classic"
],
- "operationId": "teams/remove-repo-in-org",
+ "operationId": "projects-classic/delete-card",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card"
},
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
"in": "path",
"required": true,
"schema": {
- "type": "string"
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
},
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "304": {
+ "description": "Not modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
},
- {
- "name": "repo",
- "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "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"
+ }
+ }
+ }
+ }
}
}
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
},
"x-github": {
- "githubCloudOnly": false,
+ "githubCloudOnly": true,
"enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
}
},
- "/orgs/{org}/teams/{team_slug}/teams": {
- "get": {
- "summary": "List child teams",
- "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
+ "/projects/columns/cards/{card_id}/moves": {
+ "post": {
+ "summary": "Move a project card",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
- "teams"
+ "projects-classic"
],
- "operationId": "teams/list-child-in-org",
+ "operationId": "projects-classic/move-card",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card"
},
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
+ "name": "card_id",
+ "description": "The unique identifier of the card.",
"in": "path",
"required": true,
"schema": {
- "type": "string"
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
+ "type": "integer"
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "position": {
+ "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.",
+ "example": "bottom",
+ "type": "string",
+ "pattern": "^(?:top|bottom|after:\\d+)$"
+ },
+ "column_id": {
+ "description": "The unique identifier of the column the card should be moved to",
+ "example": 42,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "type": "object"
+ },
+ "examples": {
+ "default": {
+ "summary": "Move the card to the bottom of the column",
+ "value": {
+ "column_id": 42,
+ "position": "bottom"
+ }
+ }
+ }
+ }
+ }
+ },
"responses": {
- "200": {
- "description": "if child teams exist",
+ "201": {
+ "description": "Response",
"content": {
"application/json": {
"schema": {
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {},
+ "additionalProperties": false
+ },
+ "examples": {
+ "default": {
+ "value": null
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not modified"
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
"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",
+ "code": {
"type": "string"
},
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
+ "message": {
+ "type": "string"
},
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
+ "resource": {
+ "type": "string"
},
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
+ "field": {
+ "type": "string"
}
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "parent",
- "type"
- ]
- }
- },
- "examples": {
- "response-if-child-teams-exist": {
- "value": [
- {
- "id": 2,
- "node_id": "MDQ6VGVhbTI=",
- "url": "https://api.github.com/teams/2",
- "name": "Original Roster",
- "slug": "original-roster",
- "description": "Started it all.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/2/members{/member}",
- "repositories_url": "https://api.github.com/teams/2/repos",
- "parent": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos"
- },
- "html_url": "https://github.com/orgs/rails/teams/core"
+ }
}
- ]
+ }
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
+ }
+ },
+ "401": {
+ "description": "Requires authentication",
+ "content": {
+ "application/json": {
"schema": {
- "type": "string"
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- }
- },
- "/orgs/{org}/{security_product}/{enablement}": {
- "post": {
- "summary": "Enable or disable a security feature for an organization",
- "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.",
- "tags": [
- "orgs"
- ],
- "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "security_product",
- "in": "path",
- "description": "The security feature to enable or disable.",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "dependency_graph",
- "dependabot_alerts",
- "dependabot_security_updates",
- "advanced_security",
- "code_scanning_default_setup",
- "secret_scanning",
- "secret_scanning_push_protection"
- ]
- }
},
- {
- "name": "enablement",
- "in": "path",
- "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "enable_all",
- "disable_all"
- ]
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "query_suite": {
- "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.",
- "type": "string",
- "enum": [
- "default",
- "extended"
- ]
+ "503": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ }
+ }
}
}
- },
- "examples": {
- "default": {
- "value": null
- }
}
}
- }
- },
- "responses": {
- "204": {
- "description": "Action started"
},
"422": {
- "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement"
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
- "githubCloudOnly": false,
+ "githubCloudOnly": true,
"enabledForGitHubApps": true,
- "previews": [],
- "category": "orgs",
- "subcategory": "orgs",
- "deprecationDate": "2024-07-22",
- "removalDate": "2025-07-22"
+ "category": "projects-classic",
+ "subcategory": "cards",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
},
"deprecated": true
}
},
- "/projects/columns/cards/{card_id}": {
+ "/projects/columns/{column_id}": {
"get": {
- "summary": "Get a project card",
+ "summary": "Get a project column",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"projects-classic"
],
- "operationId": "projects-classic/get-card",
+ "operationId": "projects-classic/get-column",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column"
},
"parameters": [
{
- "name": "card_id",
- "description": "The unique identifier of the card.",
+ "name": "column_id",
+ "description": "The unique identifier of the column.",
"in": "path",
"required": true,
"schema": {
@@ -189439,200 +188946,57 @@
"content": {
"application/json": {
"schema": {
- "title": "Project Card",
- "description": "Project cards represent a scope of work.",
+ "title": "Project Column",
+ "description": "Project columns contain cards of work.",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/projects/columns/cards/1478"
+ "example": "https://api.github.com/projects/columns/367"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367/cards"
},
"id": {
- "description": "The project card's ID",
+ "description": "The unique identifier of the project column",
"example": 42,
- "type": "integer",
- "format": "int64"
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
- },
- "note": {
- "type": "string",
- "example": "Add payload for delete Project column",
- "nullable": true
+ "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2016-09-05T14:21:06Z"
+ "example": "2016-09-05T14:18:44Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2016-09-05T14:20:22Z"
- },
- "archived": {
- "description": "Whether or not the card is archived",
- "example": false,
- "type": "boolean"
- },
- "column_name": {
- "type": "string"
- },
- "project_id": {
- "type": "string"
- },
- "column_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "content_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
+ "example": "2016-09-05T14:22:28Z"
}
},
"required": [
"id",
"node_id",
- "note",
"url",
- "column_url",
"project_url",
- "creator",
+ "cards_url",
+ "name",
"created_at",
"updated_at"
]
@@ -189640,36 +189004,14 @@
"examples": {
"default": {
"value": {
- "url": "https://api.github.com/projects/columns/cards/1478",
- "id": 1478,
- "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
- "note": "Add payload for delete Project column",
- "creator": {
- "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
- },
- "created_at": "2016-09-05T14:21:06Z",
- "updated_at": "2016-09-05T14:20:22Z",
- "archived": false,
- "column_url": "https://api.github.com/projects/columns/367",
- "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
- "project_url": "https://api.github.com/projects/120"
+ "url": "https://api.github.com/projects/columns/367",
+ "project_url": "https://api.github.com/projects/120",
+ "cards_url": "https://api.github.com/projects/columns/367/cards",
+ "id": 367,
+ "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
+ "name": "To Do",
+ "created_at": "2016-09-05T14:18:44Z",
+ "updated_at": "2016-09-05T14:22:28Z"
}
}
}
@@ -189705,8 +189047,8 @@
}
}
},
- "401": {
- "description": "Requires authentication",
+ "404": {
+ "description": "Resource not found",
"content": {
"application/json": {
"schema": {
@@ -189731,8 +189073,8 @@
}
}
},
- "404": {
- "description": "Resource not found",
+ "401": {
+ "description": "Requires authentication",
"content": {
"application/json": {
"schema": {
@@ -189759,30 +189101,30 @@
}
},
"x-github": {
- "githubCloudOnly": true,
+ "githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "projects-classic",
- "subcategory": "cards",
+ "subcategory": "columns",
"deprecationDate": "2024-05-23",
"removalDate": "2025-04-01"
},
"deprecated": true
},
"patch": {
- "summary": "Update an existing project card",
+ "summary": "Update an existing project column",
"description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"projects-classic"
],
- "operationId": "projects-classic/update-card",
+ "operationId": "projects-classic/update-column",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column"
},
"parameters": [
{
- "name": "card_id",
- "description": "The unique identifier of the card.",
+ "name": "column_id",
+ "description": "The unique identifier of the column.",
"in": "path",
"required": true,
"schema": {
@@ -189791,30 +189133,27 @@
}
],
"requestBody": {
- "required": false,
+ "required": true,
"content": {
"application/json": {
"schema": {
- "type": "object",
"properties": {
- "note": {
- "description": "The project card's note",
- "example": "Update all gems",
- "type": "string",
- "nullable": true
- },
- "archived": {
- "description": "Whether or not the card is archived",
- "example": false,
- "type": "boolean"
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
}
- }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
},
"examples": {
"default": {
- "summary": "Change the note on the card",
+ "summary": "Rename the project column",
"value": {
- "note": "Add payload for delete Project column"
+ "name": "To Do"
}
}
}
@@ -189827,1027 +189166,43 @@
"content": {
"application/json": {
"schema": {
- "title": "Project Card",
- "description": "Project cards represent a scope of work.",
+ "title": "Project Column",
+ "description": "Project columns contain cards of work.",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/projects/columns/cards/1478"
+ "example": "https://api.github.com/projects/columns/367"
+ },
+ "project_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/120"
+ },
+ "cards_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/projects/columns/367/cards"
},
"id": {
- "description": "The project card's ID",
+ "description": "The unique identifier of the project column",
"example": 42,
- "type": "integer",
- "format": "int64"
+ "type": "integer"
},
"node_id": {
"type": "string",
- "example": "MDExOlByb2plY3RDYXJkMTQ3OA=="
- },
- "note": {
- "type": "string",
- "example": "Add payload for delete Project column",
- "nullable": true
+ "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
},
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "name": {
+ "description": "Name of the project column",
+ "example": "Remaining tasks",
+ "type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2016-09-05T14:21:06Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:20:22Z"
- },
- "archived": {
- "description": "Whether or not the card is archived",
- "example": false,
- "type": "boolean"
- },
- "column_name": {
- "type": "string"
- },
- "project_id": {
- "type": "string"
- },
- "column_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "content_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/api-playground/projects-test/issues/3"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
- }
- },
- "required": [
- "id",
- "node_id",
- "note",
- "url",
- "column_url",
- "project_url",
- "creator",
- "created_at",
- "updated_at"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "url": "https://api.github.com/projects/columns/cards/1478",
- "id": 1478,
- "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==",
- "note": "Add payload for delete Project column",
- "creator": {
- "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
- },
- "created_at": "2016-09-05T14:21:06Z",
- "updated_at": "2016-09-05T14:20:22Z",
- "archived": false,
- "column_url": "https://api.github.com/projects/columns/367",
- "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3",
- "project_url": "https://api.github.com/projects/120"
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error Simple",
- "description": "Validation Error Simple",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "cards",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a project card",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/delete-card",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card"
- },
- "parameters": [
- {
- "name": "card_id",
- "description": "The unique identifier of the card.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "cards",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- }
- },
- "/projects/columns/cards/{card_id}/moves": {
- "post": {
- "summary": "Move a project card",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/move-card",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card"
- },
- "parameters": [
- {
- "name": "card_id",
- "description": "The unique identifier of the card.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "position": {
- "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.",
- "example": "bottom",
- "type": "string",
- "pattern": "^(?:top|bottom|after:\\d+)$"
- },
- "column_id": {
- "description": "The unique identifier of the column the card should be moved to",
- "example": 42,
- "type": "integer"
- }
- },
- "required": [
- "position"
- ],
- "type": "object"
- },
- "examples": {
- "default": {
- "summary": "Move the card to the bottom of the column",
- "value": {
- "column_id": 42,
- "position": "bottom"
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
- },
- "examples": {
- "default": {
- "value": null
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "503": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "cards",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- }
- },
- "/projects/columns/{column_id}": {
- "get": {
- "summary": "Get a project column",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/get-column",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column"
- },
- "parameters": [
- {
- "name": "column_id",
- "description": "The unique identifier of the column.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Project Column",
- "description": "Project columns contain cards of work.",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
- },
- "cards_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367/cards"
- },
- "id": {
- "description": "The unique identifier of the project column",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
- },
- "name": {
- "description": "Name of the project column",
- "example": "Remaining tasks",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:18:44Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:22:28Z"
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "project_url",
- "cards_url",
- "name",
- "created_at",
- "updated_at"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "url": "https://api.github.com/projects/columns/367",
- "project_url": "https://api.github.com/projects/120",
- "cards_url": "https://api.github.com/projects/columns/367/cards",
- "id": 367,
- "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=",
- "name": "To Do",
- "created_at": "2016-09-05T14:18:44Z",
- "updated_at": "2016-09-05T14:22:28Z"
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Requires authentication",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "projects-classic",
- "subcategory": "columns",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update an existing project column",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "projects-classic"
- ],
- "operationId": "projects-classic/update-column",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column"
- },
- "parameters": [
- {
- "name": "column_id",
- "description": "The unique identifier of the column.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "name": {
- "description": "Name of the project column",
- "example": "Remaining tasks",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "examples": {
- "default": {
- "summary": "Rename the project column",
- "value": {
- "name": "To Do"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Project Column",
- "description": "Project columns contain cards of work.",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367"
- },
- "project_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/120"
- },
- "cards_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/projects/columns/367/cards"
- },
- "id": {
- "description": "The unique identifier of the project column",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDEzOlByb2plY3RDb2x1bW4zNjc="
- },
- "name": {
- "description": "Name of the project column",
- "example": "Remaining tasks",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2016-09-05T14:18:44Z"
+ "example": "2016-09-05T14:18:44Z"
},
"updated_at": {
"type": "string",
@@ -467378,1522 +465733,276 @@
"delete": {
"summary": "Remove an authorized SSH key",
"description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).",
- "operationId": "enterprise-admin/remove-authorized-ssh-key",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "pretty-print": {
- "type": "string"
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
- "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
- },
- {
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
- "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
- },
- {
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
- "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
- }
- ]
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/x-www-form-urlencoded": {
- "schema": {
- "type": "object",
- "properties": {
- "authorized_key": {
- "type": "string",
- "description": "The public SSH key."
- }
- },
- "required": [
- "authorized_key"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/setup/api/start": {
- "post": {
- "summary": "Create a GitHub license",
- "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
- "operationId": "enterprise-admin/create-enterprise-server-license",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#create-a-github-license"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "202": {
- "description": "Response"
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "license": {
- "type": "string",
- "description": "The content of your _.ghl_ license file."
- },
- "password": {
- "type": "string",
- "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter."
- },
- "settings": {
- "type": "string",
- "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings)."
- }
- },
- "required": [
- "license"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "license": "@enterprise.ghl",
- "password": "secret"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/setup/api/upgrade": {
- "post": {
- "summary": "Upgrade a license",
- "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
- "operationId": "enterprise-admin/upgrade-license",
- "tags": [
- "enterprise-admin"
- ],
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#upgrade-a-license"
- },
- "servers": [
- {
- "url": "{protocol}://{hostname}",
- "variables": {
- "hostname": {
- "default": "HOSTNAME",
- "description": "Self-hosted Enterprise Server hostname"
- },
- "protocol": {
- "default": "http",
- "description": "Self-hosted Enterprise Server protocol"
- }
- }
- }
- ],
- "responses": {
- "202": {
- "description": "Response"
- },
- "401": {
- "description": "Unauthorized"
- }
- },
- "requestBody": {
- "required": false,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "license": {
- "type": "string",
- "description": "The content of your new _.ghl_ license file."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "license": "@enterprise.ghl"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": false,
- "category": "enterprise-admin",
- "subcategory": "management-console"
- }
- }
- },
- "/teams/{team_id}": {
- "get": {
- "summary": "Get a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- },
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the team."
- },
- "description": {
- "type": "string",
- "description": "The description of the team."
- },
- "privacy": {
- "type": "string",
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
- "enum": [
- "secret",
- "closed"
- ]
- },
- "notification_setting": {
- "type": "string",
- "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ]
- },
- "permission": {
- "type": "string",
- "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
- "enum": [
- "pull",
- "push",
- "admin"
- ],
- "default": "pull"
- },
- "parent_team_id": {
- "type": "integer",
- "description": "The ID of a team to set as the parent team.",
- "nullable": true
- }
- },
- "required": [
- "name"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed",
- "notification_setting": "notifications_enabled"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response when the updated information already exists",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "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"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
+ "operationId": "enterprise-admin/remove-authorized-ssh-key",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
},
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
+ "pretty-print": {
+ "type": "string"
+ }
}
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
+ }
},
"examples": {
"default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
+ "value": [
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
},
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
- }
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ },
+ {
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...",
+ "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64"
+ }
+ ]
}
}
}
}
},
- "201": {
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "authorized_key": {
+ "type": "string",
+ "description": "The public SSH key."
+ }
+ },
+ "required": [
+ "authorized_key"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw=="
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/start": {
+ "post": {
+ "summary": "Create a GitHub license",
+ "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
+ "operationId": "enterprise-admin/create-enterprise-server-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#create-a-github-license"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response"
+ },
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your _.ghl_ license file."
+ },
+ "password": {
+ "type": "string",
+ "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter."
+ },
+ "settings": {
+ "type": "string",
+ "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings)."
+ }
+ },
+ "required": [
+ "license"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "license": "@enterprise.ghl",
+ "password": "secret"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/setup/api/upgrade": {
+ "post": {
+ "summary": "Upgrade a license",
+ "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).",
+ "operationId": "enterprise-admin/upgrade-license",
+ "tags": [
+ "enterprise-admin"
+ ],
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#upgrade-a-license"
+ },
+ "servers": [
+ {
+ "url": "{protocol}://{hostname}",
+ "variables": {
+ "hostname": {
+ "default": "HOSTNAME",
+ "description": "Self-hosted Enterprise Server hostname"
+ },
+ "protocol": {
+ "default": "http",
+ "description": "Self-hosted Enterprise Server protocol"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Response"
+ },
+ "401": {
+ "description": "Unauthorized"
+ }
+ },
+ "requestBody": {
+ "required": false,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "license": {
+ "type": "string",
+ "description": "The content of your new _.ghl_ license file."
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "license": "@enterprise.ghl"
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": false,
+ "category": "enterprise-admin",
+ "subcategory": "management-console"
+ }
+ }
+ },
+ "/teams/{team_id}": {
+ "get": {
+ "summary": "Get a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "description": "The unique identifier of the team.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
@@ -469479,233 +466588,6 @@
}
}
}
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "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": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
}
},
"x-github": {
@@ -469717,436 +466599,17 @@
"subcategory": "teams"
},
"deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
},
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "patch": {
+ "summary": "Update a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -470166,30 +466629,57 @@
"schema": {
"type": "object",
"properties": {
- "title": {
+ "name": {
"type": "string",
- "description": "The discussion post's title."
+ "description": "The name of the team."
},
- "body": {
+ "description": {
"type": "string",
- "description": "The discussion post's body text."
+ "description": "The description of the team."
},
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.",
+ "nullable": true
}
},
"required": [
- "title",
- "body"
+ "name"
]
},
"examples": {
"default": {
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
}
}
}
@@ -470197,1135 +466687,1248 @@
}
},
"responses": {
- "201": {
- "description": "Response",
+ "200": {
+ "description": "Response when the updated information already exists",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
- "example": 0
+ "example": 3
},
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
- "url": {
+ "login": {
"type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
+ "example": "github"
},
- "confused": {
- "type": "integer"
+ "id": {
+ "type": "integer",
+ "example": 1
},
- "heart": {
- "type": "integer"
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
- "hooray": {
- "type": "integer"
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "eyes": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "login": {
+ "issues_url": {
"type": "string",
- "example": "octocat"
+ "example": "https://api.github.com/orgs/github/issues"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "node_id": {
+ "public_members_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
"avatar_url": {
"type": "string",
- "format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "A great organization",
"nullable": true
},
- "url": {
+ "name": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "github"
},
- "html_url": {
+ "company": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "GitHub"
},
- "followers_url": {
+ "blog": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "https://github.com/blog"
},
- "following_url": {
+ "location": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "San Francisco"
},
- "gists_url": {
+ "email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "format": "email",
+ "example": "octocat@github.com"
},
- "starred_url": {
+ "twitter_username": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "github",
+ "nullable": true
},
- "subscriptions_url": {
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "https://github.com/octocat"
},
- "organizations_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
},
- "repos_url": {
+ "type": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "Organization"
},
- "events_url": {
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
},
- "received_events_url": {
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
},
- "type": {
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
"type": "string",
- "example": "User"
+ "example": "all"
},
- "site_admin": {
- "type": "boolean"
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
},
- "starred_at": {
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "date-time"
},
- "user_view_type": {
+ "archived_at": {
"type": "string",
- "example": "public"
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
+ "login",
+ "url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
"repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
"type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
- "type": "integer",
- "example": 0
- },
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "team_url": {
+ "ldap_dn": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
},
- "updated_at": {
+ "type": {
+ "description": "The ownership type of the team",
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"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
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 0,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
+ "html_url": "https://github.com/octocat",
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ },
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
+ "201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"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
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "comments_count": {
+ "members_count": {
"type": "integer",
- "example": 0
+ "example": 3
},
- "comments_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
+ "login",
"url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "comments_count",
- "comments_url",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
"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
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "comments_count": 1,
- "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -471334,20 +467937,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-legacy",
+ "operationId": "teams/delete-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -471358,20 +467961,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "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": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -471380,22 +468069,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments": {
+ "/teams/{team_id}/discussions": {
"get": {
- "summary": "List discussion comments (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List discussions (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussion-comments-legacy",
+ "operationId": "teams/list-discussions-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy"
},
"parameters": [
{
@@ -471407,15 +468096,6 @@
"type": "integer"
}
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
{
"name": "direction",
"description": "The direction to sort the results by.",
@@ -471457,8 +468137,8 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -471587,13 +468267,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -471603,41 +468283,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -471696,10 +468391,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -471729,19 +468427,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -471774,20 +468475,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"post": {
- "summary": "Create a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Create a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-comment-legacy",
+ "operationId": "teams/create-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy"
},
"parameters": [
{
@@ -471798,15 +468499,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
@@ -471816,19 +468508,30 @@
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
+ },
+ "private": {
+ "type": "boolean",
+ "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
+ "default": false
}
},
"required": [
+ "title",
"body"
]
},
"examples": {
"default": {
"value": {
- "body": "Do you like apples?"
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
}
}
}
@@ -471841,8 +468544,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -471971,13 +468674,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -471987,41 +468690,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -472080,10 +468798,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -472111,19 +468832,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -472148,22 +468872,22 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
},
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": {
+ "/teams/{team_id}/discussions/{discussion_number}": {
"get": {
- "summary": "Get a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-comment-legacy",
+ "operationId": "teams/get-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy"
},
"parameters": [
{
@@ -472183,15 +468907,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -472200,8 +468915,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -472330,13 +469045,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -472346,41 +469061,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -472439,10 +469169,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -472470,19 +469203,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like apples?",
- "body_html": "Do you like apples?
",
- "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": null,
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
- "updated_at": "2018-01-15T23:53:58Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Our first team post",
+ "updated_at": "2018-01-25T18:56:31Z",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -472506,20 +469242,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"patch": {
- "summary": "Update a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Update a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-comment-legacy",
+ "operationId": "teams/update-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy"
},
"parameters": [
{
@@ -472539,37 +469275,29 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "The discussion post's title."
+ },
"body": {
"type": "string",
- "description": "The discussion comment's body text."
+ "description": "The discussion post's body text."
}
- },
- "required": [
- "body"
- ]
+ }
},
"examples": {
"default": {
"value": {
- "body": "Do you like pineapples?"
+ "title": "Welcome to our first team post"
}
}
}
@@ -472582,8 +469310,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion Comment",
- "description": "A reply to a discussion within a team.",
+ "title": "Team Discussion",
+ "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
"author": {
@@ -472712,13 +469440,13 @@
"nullable": true
},
"body": {
- "description": "The main text of the comment.",
- "example": "I agree with this suggestion.",
+ "description": "The main text of the discussion.",
+ "example": "Please suggest improvements to our workflow in comments.",
"type": "string"
},
"body_html": {
"type": "string",
- "example": "Do you like apples?
"
+ "example": "Hi! This is an area for us to collaborate as a team
"
},
"body_version": {
"description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
@@ -472728,41 +469456,56 @@
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"last_edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
- "discussion_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1"
- },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1"
+ "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
},
"node_id": {
"type": "string",
- "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE="
+ "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
},
"number": {
- "description": "The unique sequence number of a team discussion comment.",
+ "description": "The unique sequence number of a team discussion.",
"example": 42,
"type": "integer"
},
+ "pinned": {
+ "description": "Whether or not this discussion should be pinned for easy retrieval.",
+ "example": true,
+ "type": "boolean"
+ },
+ "private": {
+ "description": "Whether or not this discussion should be restricted to team members and organization owners.",
+ "example": true,
+ "type": "boolean"
+ },
+ "team_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/2343027"
+ },
+ "title": {
+ "description": "The title of the discussion.",
+ "example": "How can we improve our workflow?",
+ "type": "string"
+ },
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-15T23:53:58Z"
+ "example": "2018-01-25T18:56:31Z"
},
"url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1"
+ "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
},
"reactions": {
"title": "Reaction Rollup",
@@ -472821,10 +469564,13 @@
"body_version",
"created_at",
"last_edited_at",
- "discussion_url",
"html_url",
+ "pinned",
+ "private",
"node_id",
"number",
+ "team_url",
+ "title",
"updated_at",
"url"
]
@@ -472852,19 +469598,22 @@
"type": "User",
"site_admin": false
},
- "body": "Do you like pineapples?",
- "body_html": "Do you like pineapples?
",
- "body_version": "e6907b24d9c93cc0c5024a7af5888116",
- "created_at": "2018-01-15T23:53:58Z",
+ "body": "Hi! This is an area for us to collaborate as a team.",
+ "body_html": "Hi! This is an area for us to collaborate as a team
",
+ "body_version": "0d495416a700fb06133c612575d92bfb",
+ "created_at": "2018-01-25T18:56:31Z",
"last_edited_at": "2018-01-26T18:22:20Z",
- "discussion_url": "https://api.github.com/teams/2403582/discussions/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
- "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
+ "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
+ "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
"number": 1,
+ "pinned": false,
+ "private": false,
+ "team_url": "https://api.github.com/teams/2343027",
+ "title": "Welcome to our first team post",
"updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
+ "url": "https://api.github.com/teams/2343027/discussions/1",
"reactions": {
- "url": "https://api.github.com/teams/2403582/discussions/1/reactions",
+ "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
@@ -472888,20 +469637,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion comment (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a discussion (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-comment-legacy",
+ "operationId": "teams/delete-discussion-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy"
},
"parameters": [
{
@@ -472921,15 +469670,6 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "comment_number",
- "description": "The number that identifies the comment.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
@@ -472943,7 +469683,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussion-comments"
+ "subcategory": "discussions"
},
"deprecated": true
}
diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.yaml b/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.yaml
index 11b31b565..28833ddcb 100644
--- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.yaml
+++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.deref.yaml
@@ -4479,7 +4479,7 @@ paths:
application/json:
schema: *24
application/scim+json:
- schema: &551
+ schema: &548
title: Scim Error
description: Scim Error
type: object
@@ -12365,7 +12365,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &382
+ instances_url: &379
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -12400,7 +12400,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &383
+ dismissed_reason: &380
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -12409,13 +12409,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &384
+ dismissed_comment: &381
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &385
+ rule: &382
type: object
properties:
id:
@@ -12454,7 +12454,7 @@ paths:
description: A set of tags applicable for the rule.
items:
type: string
- tool: &386
+ tool: &383
type: object
properties:
name: *90
@@ -12464,26 +12464,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *91
- most_recent_instance: &387
+ most_recent_instance: &384
type: object
properties:
- ref: &380
+ ref: &377
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &392
+ analysis_key: &389
type: string
description: Identifies the configuration under which the
analysis was executed. For example, in GitHub Actions
this includes the workflow filename and job name.
- environment: &393
+ environment: &390
type: string
description: Identifies the variable values associated with
the environment in which the analysis that generated this
alert instance was performed, such as the language that
was analyzed.
- category: &394
+ category: &391
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -12497,7 +12497,7 @@ paths:
properties:
text:
type: string
- location: &395
+ location: &392
type: object
description: Describe a region within a file for the alert.
properties:
@@ -12518,7 +12518,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &396
+ items: &393
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -13300,7 +13300,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
- - &418
+ - &415
name: has
in: query
description: |-
@@ -13423,7 +13423,7 @@ paths:
enum:
- development
- runtime
- security_advisory: &419
+ security_advisory: &416
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -13654,14 +13654,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *102
- auto_dismissed_at: &420
+ auto_dismissed_at: &417
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &421
+ dismissal_request: &418
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -14137,14 +14137,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &542
+ state: &539
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: &543
+ resolution: &540
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -14730,7 +14730,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &466
+ properties: &463
id:
type: integer
format: int64
@@ -14993,7 +14993,7 @@ paths:
timeline_url:
type: string
format: uri
- type: &578
+ type: &575
title: Issue Type
description: The type of issue.
type: object
@@ -15107,7 +15107,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &575
+ sub_issues_summary: &572
title: Sub-issues Summary
type: object
properties:
@@ -15127,7 +15127,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &576
+ issue_dependencies_summary: &573
title: Issue Dependencies Summary
type: object
properties:
@@ -15146,7 +15146,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &577
+ items: &574
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -15207,7 +15207,7 @@ paths:
- node_id
- data_type
- value
- required: &467
+ required: &464
- assignee
- closed_at
- comments
@@ -15291,7 +15291,7 @@ paths:
action:
type: string
issue: *109
- comment: &462
+ comment: &459
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -15950,7 +15950,7 @@ paths:
- review_comment
- self
author_association: *110
- auto_merge: &410
+ auto_merge: &407
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -16414,7 +16414,7 @@ paths:
type: string
release:
allOf:
- - &520
+ - &517
title: Release
description: A release.
type: object
@@ -16485,7 +16485,7 @@ paths:
author: *19
assets:
type: array
- items: &521
+ items: &518
title: Release Asset
description: Data related to a release.
type: object
@@ -17065,7 +17065,7 @@ paths:
url:
type: string
format: uri
- user: &593
+ user: &588
title: Public User
description: Public User
type: object
@@ -21685,14 +21685,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &302
+ - &299
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &303
+ - &300
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -21764,7 +21764,7 @@ paths:
'404': *26
'403': *43
'304': *42
- '301': &314
+ '301': &311
description: Moved permanently
content:
application/json:
@@ -21786,7 +21786,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &494
+ - &491
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -21794,7 +21794,7 @@ paths:
schema:
type: boolean
default: false
- - &495
+ - &492
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -21804,7 +21804,7 @@ paths:
type: boolean
default: false
- *119
- - &496
+ - &493
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:
@@ -22248,7 +22248,7 @@ paths:
- url
- subscription_url
examples:
- default: &497
+ default: &494
value:
- id: '1'
repository:
@@ -22794,7 +22794,7 @@ paths:
type: array
items: *70
examples:
- default: &602
+ default: &597
value:
- login: github
id: 1
@@ -23685,7 +23685,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &319
+ items: &316
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -23936,7 +23936,7 @@ paths:
type: array
items: *84
examples:
- default: &599
+ default: &594
value:
total_count: 1
repositories:
@@ -25737,7 +25737,7 @@ paths:
description: Response
content:
application/json:
- schema: &341
+ schema: &338
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -25766,7 +25766,7 @@ paths:
- key_id
- key
examples:
- default: &342
+ default: &339
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -26179,7 +26179,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-organization-variables
parameters:
- *140
- - &326
+ - &323
name: per_page
description: The number of results per page (max 30). For more information,
see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -26828,7 +26828,7 @@ paths:
be returned.
in: query
required: false
- schema: &381
+ schema: &378
type: string
description: Severity of a code scanning alert.
enum:
@@ -27370,7 +27370,7 @@ paths:
description: Response
content:
application/json:
- schema: &424
+ schema: &421
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -27387,7 +27387,7 @@ paths:
- key_id
- key
examples:
- default: &425
+ default: &422
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -27985,7 +27985,7 @@ paths:
description: Response
content:
application/json:
- schema: &297
+ schema: &294
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -28066,7 +28066,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &298
+ default: &295
value:
group_id: '123'
group_name: Octocat admins
@@ -28121,7 +28121,7 @@ paths:
description: Response
content:
application/json:
- schema: &295
+ schema: &292
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -28158,7 +28158,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &296
+ default: &293
value:
groups:
- group_id: '123'
@@ -28794,7 +28794,7 @@ paths:
application/json:
schema: *39
examples:
- default: &459
+ default: &456
value:
id: 1
account:
@@ -31482,7 +31482,7 @@ paths:
- nuget
- container
- *140
- - &603
+ - &598
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -31523,7 +31523,7 @@ paths:
default: *225
'403': *43
'401': *41
- '400': &605
+ '400': &600
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -33976,7 +33976,7 @@ paths:
description: Response
content:
application/json:
- schema: &313
+ schema: &310
title: Full Repository
description: Full Repository
type: object
@@ -34474,7 +34474,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &315
+ default: &312
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -35046,7 +35046,7 @@ paths:
- *140
- *4
- *5
- - &528
+ - &525
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -35320,7 +35320,7 @@ paths:
- repository_property
rules:
type: array
- items: &529
+ items: &526
title: Repository Rule
type: object
description: A repository rule.
@@ -36066,7 +36066,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *140
- - &530
+ - &527
name: ref
description: The name of the ref. Cannot contain wildcard characters. When
specified, only rule evaluations triggered for this ref will be returned.
@@ -36079,7 +36079,7 @@ paths:
in: query
schema:
type: string
- - &531
+ - &528
name: time_period
description: |-
The time period to filter by.
@@ -36095,14 +36095,14 @@ paths:
- week
- month
default: day
- - &532
+ - &529
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
- - &533
+ - &530
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -36122,7 +36122,7 @@ paths:
description: Response
content:
application/json:
- schema: &534
+ schema: &531
title: Rule Suites
description: Response
type: array
@@ -36176,7 +36176,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &535
+ default: &532
value:
- id: 21
actor_id: 12
@@ -36220,7 +36220,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *140
- - &536
+ - &533
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -36236,7 +36236,7 @@ paths:
description: Response
content:
application/json:
- schema: &537
+ schema: &534
title: Rule Suite
description: Response
type: object
@@ -36334,7 +36334,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &538
+ default: &535
value:
id: 21
actor_id: 12
@@ -36552,7 +36552,7 @@ paths:
- *9
- *5
- *4
- - &540
+ - &537
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -36562,7 +36562,7 @@ paths:
required: false
schema:
type: string
- - &541
+ - &538
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -36734,7 +36734,7 @@ paths:
application/json:
schema:
type: array
- items: &304
+ items: &301
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -37519,13 +37519,6 @@ paths:
does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
- comments_count:
- type: integer
- example: 0
- comments_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
@@ -37577,8 +37570,6 @@ paths:
- body
- body_html
- body_version
- - comments_count
- - comments_url
- created_at
- last_edited_at
- html_url
@@ -37591,7 +37582,7 @@ paths:
- updated_at
- url
examples:
- default: &583
+ default: &580
value:
- author:
login: octocat
@@ -37616,8 +37607,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -37727,8 +37716,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 0
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at:
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -37839,7 +37826,7 @@ paths:
application/json:
schema: *289
examples:
- default: &584
+ default: &581
value:
author:
login: octocat
@@ -37864,8 +37851,6 @@ paths:
body_html: "Hi! This is an area for us to collaborate as a
team
"
body_version: 0d495416a700fb06133c612575d92bfb
- comments_count: 1
- comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
@@ -37920,410 +37905,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments
- description: |-
- List all comments on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments
- parameters:
- - *140
- - *219
- - *291
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &292
- title: Team Discussion Comment
- description: A reply to a discussion within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *17
- required: *18
- nullable: true
- body:
- description: The main text of the comment.
- example: I agree with this suggestion.
- type: string
- body_html:
- type: string
- example: "Do you like apples?
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- discussion_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id:
- type: string
- example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number:
- description: The unique sequence number of a team discussion
- comment.
- example: 42
- type: integer
- updated_at:
- type: string
- format: date-time
- example: '2018-01-15T23:53:58Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- reactions: *111
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - discussion_url
- - html_url
- - node_id
- - number
- - updated_at
- - url
- examples:
- default: &585
- value:
- - author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- headers:
- Link: *6
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- post:
- summary: Create a discussion comment
- description: |-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: &293
- value:
- author:
- 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
- body: Do you like apples?
- body_html: "Do you like apples?
"
- body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at:
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-15T23:53:58Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment
- description: |-
- Get a specific comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- - &294
- name: comment_number
- description: The number that identifies the comment.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *293
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- patch:
- summary: Update a discussion comment
- description: |-
- Edits the body text of a discussion comment.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- - *294
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: &586
- value:
- author:
- 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
- body: Do you like pineapples?
- body_html: "Do you like pineapples?
"
- body_version: e6907b24d9c93cc0c5024a7af5888116
- created_at: '2018-01-15T23:53:58Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- discussion_url: https://api.github.com/teams/2403582/discussions/1
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
- node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
- number: 1
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2403582/discussions/1/comments/1
- reactions:
- url: https://api.github.com/teams/2403582/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
- delete:
- summary: Delete a discussion comment
- description: |-
- Deletes a comment on a team discussion.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment
- parameters:
- - *140
- - *219
- - *291
- - *294
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussion-comments
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -38345,9 +37926,9 @@ paths:
description: Response
content:
application/json:
- schema: *295
+ schema: *292
examples:
- default: *296
+ default: *293
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -38390,9 +37971,9 @@ paths:
description: Response
content:
application/json:
- schema: *297
+ schema: *294
examples:
- default: *298
+ default: *295
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -38497,7 +38078,7 @@ paths:
description: Response
content:
application/json:
- schema: &299
+ schema: &296
title: Team Membership
description: Team Membership
type: object
@@ -38524,7 +38105,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &587
+ response-if-user-is-a-team-maintainer: &582
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -38587,9 +38168,9 @@ paths:
description: Response
content:
application/json:
- schema: *299
+ schema: *296
examples:
- response-if-users-membership-with-team-is-now-pending: &588
+ response-if-users-membership-with-team-is-now-pending: &583
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -38662,7 +38243,7 @@ paths:
application/json:
schema:
type: array
- items: &300
+ items: &297
title: Team Project
description: A team's access to a project.
type: object
@@ -38730,7 +38311,7 @@ paths:
- updated_at
- permissions
examples:
- default: &589
+ default: &584
value:
- owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -38795,7 +38376,7 @@ paths:
parameters:
- *140
- *219
- - &301
+ - &298
name: project_id
description: The unique identifier of the project.
in: path
@@ -38807,9 +38388,9 @@ paths:
description: Response
content:
application/json:
- schema: *300
+ schema: *297
examples:
- default: &590
+ default: &585
value:
owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -38873,7 +38454,7 @@ paths:
parameters:
- *140
- *219
- - *301
+ - *298
requestBody:
required: false
content:
@@ -38941,7 +38522,7 @@ paths:
parameters:
- *140
- *219
- - *301
+ - *298
responses:
'204':
description: Response
@@ -39012,14 +38593,14 @@ paths:
parameters:
- *140
- *219
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &591
+ schema: &586
title: Team Repository
description: A team's access to a repository.
type: object
@@ -39590,8 +39171,8 @@ paths:
parameters:
- *140
- *219
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -39638,8 +39219,8 @@ paths:
parameters:
- *140
- *219
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -39674,9 +39255,9 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
- response-if-child-teams-exist: &592
+ response-if-child-teams-exist: &587
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -39803,7 +39384,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card
parameters:
- - &305
+ - &302
name: card_id
description: The unique identifier of the card.
in: path
@@ -39815,7 +39396,7 @@ paths:
description: Response
content:
application/json:
- schema: &306
+ schema: &303
title: Project Card
description: Project cards represent a scope of work.
type: object
@@ -39882,7 +39463,7 @@ paths:
- created_at
- updated_at
examples:
- default: &307
+ default: &304
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
@@ -39938,7 +39519,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card
parameters:
- - *305
+ - *302
requestBody:
required: false
content:
@@ -39965,9 +39546,9 @@ paths:
description: Response
content:
application/json:
- schema: *306
+ schema: *303
examples:
- default: *307
+ default: *304
'304': *42
'403': *43
'401': *41
@@ -39994,7 +39575,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card
parameters:
- - *305
+ - *302
responses:
'204':
description: Response
@@ -40038,7 +39619,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card
parameters:
- - *305
+ - *302
requestBody:
required: true
content:
@@ -40149,7 +39730,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column
parameters:
- - &308
+ - &305
name: column_id
description: The unique identifier of the column.
in: path
@@ -40161,7 +39742,7 @@ paths:
description: Response
content:
application/json:
- schema: &309
+ schema: &306
title: Project Column
description: Project columns contain cards of work.
type: object
@@ -40207,7 +39788,7 @@ paths:
- created_at
- updated_at
examples:
- default: &310
+ default: &307
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
@@ -40242,7 +39823,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column
parameters:
- - *308
+ - *305
requestBody:
required: true
content:
@@ -40266,9 +39847,9 @@ paths:
description: Response
content:
application/json:
- schema: *309
+ schema: *306
examples:
- default: *310
+ default: *307
'304': *42
'403': *43
'401': *41
@@ -40293,7 +39874,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column
parameters:
- - *308
+ - *305
responses:
'204':
description: Response
@@ -40322,7 +39903,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#list-project-cards
parameters:
- - *308
+ - *305
- name: archived_state
description: Filters the project cards that are returned by the card's state.
in: query
@@ -40343,7 +39924,7 @@ paths:
application/json:
schema:
type: array
- items: *306
+ items: *303
examples:
default:
value:
@@ -40402,7 +39983,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#create-a-project-card
parameters:
- - *308
+ - *305
requestBody:
required: true
content:
@@ -40442,9 +40023,9 @@ paths:
description: Response
content:
application/json:
- schema: *306
+ schema: *303
examples:
- default: *307
+ default: *304
'304': *42
'403': *43
'401': *41
@@ -40500,7 +40081,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#move-a-project-column
parameters:
- - *308
+ - *305
requestBody:
required: true
content:
@@ -40559,7 +40140,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#get-a-project
parameters:
- - *301
+ - *298
responses:
'200':
description: Response
@@ -40567,7 +40148,7 @@ paths:
application/json:
schema: *242
examples:
- default: &311
+ default: &308
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
@@ -40621,7 +40202,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#update-a-project
parameters:
- - *301
+ - *298
requestBody:
required: false
content:
@@ -40669,7 +40250,7 @@ paths:
application/json:
schema: *242
examples:
- default: *311
+ default: *308
'404':
description: Not Found if the authenticated user does not have access to
the project
@@ -40709,7 +40290,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#delete-a-project
parameters:
- - *301
+ - *298
responses:
'204':
description: Delete Success
@@ -40752,7 +40333,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#list-project-collaborators
parameters:
- - *301
+ - *298
- 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
@@ -40809,7 +40390,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#add-project-collaborator
parameters:
- - *301
+ - *298
- *8
requestBody:
required: false
@@ -40862,7 +40443,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#remove-user-as-a-collaborator
parameters:
- - *301
+ - *298
- *8
responses:
'204':
@@ -40894,7 +40475,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#get-project-permission-for-a-user
parameters:
- - *301
+ - *298
- *8
responses:
'200':
@@ -40968,7 +40549,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#list-project-columns
parameters:
- - *301
+ - *298
- *4
- *5
responses:
@@ -40978,7 +40559,7 @@ paths:
application/json:
schema:
type: array
- items: *309
+ items: *306
examples:
default:
value:
@@ -41016,7 +40597,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#create-a-project-column
parameters:
- - *301
+ - *298
requestBody:
required: true
content:
@@ -41039,7 +40620,7 @@ paths:
description: Response
content:
application/json:
- schema: *309
+ schema: *306
examples:
default:
value:
@@ -41104,7 +40685,7 @@ paths:
resources:
type: object
properties:
- core: &312
+ core: &309
title: Rate Limit
type: object
properties:
@@ -41121,20 +40702,20 @@ paths:
- remaining
- reset
- used
- graphql: *312
- search: *312
- code_search: *312
- source_import: *312
- integration_manifest: *312
- code_scanning_upload: *312
- actions_runner_registration: *312
- scim: *312
- dependency_sbom: *312
- code_scanning_autofix: *312
+ graphql: *309
+ search: *309
+ code_search: *309
+ source_import: *309
+ integration_manifest: *309
+ code_scanning_upload: *309
+ actions_runner_registration: *309
+ scim: *309
+ dependency_sbom: *309
+ code_scanning_autofix: *309
required:
- core
- search
- rate: *312
+ rate: *309
required:
- rate
- resources
@@ -41239,14 +40820,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
default-response:
summary: Default response
@@ -41745,7 +41326,7 @@ paths:
status: disabled
'403': *43
'404': *26
- '301': *314
+ '301': *311
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -41763,8 +41344,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#update-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -41980,10 +41561,10 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
- '307': &316
+ default: *312
+ '307': &313
description: Temporary Redirect
content:
application/json:
@@ -42028,8 +41609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -42051,7 +41632,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
- '307': *316
+ '307': *313
'404': *26
'409': *145
x-github:
@@ -42075,11 +41656,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- - &333
+ - &330
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -42102,7 +41683,7 @@ paths:
type: integer
artifacts:
type: array
- items: &317
+ items: &314
title: Artifact
description: An artifact
type: object
@@ -42173,7 +41754,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &334
+ default: &331
value:
total_count: 2
artifacts:
@@ -42232,9 +41813,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#get-an-artifact
parameters:
- - *302
- - *303
- - &318
+ - *299
+ - *300
+ - &315
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -42246,7 +41827,7 @@ paths:
description: Response
content:
application/json:
- schema: *317
+ schema: *314
examples:
default:
value:
@@ -42283,9 +41864,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#delete-an-artifact
parameters:
- - *302
- - *303
- - *318
+ - *299
+ - *300
+ - *315
responses:
'204':
description: Response
@@ -42309,9 +41890,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#download-an-artifact
parameters:
- - *302
- - *303
- - *318
+ - *299
+ - *300
+ - *315
- name: archive_format
in: path
required: true
@@ -42348,14 +41929,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *319
+ schema: *316
examples:
default:
value:
@@ -42381,14 +41962,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: &320
+ schema: &317
title: Actions cache usage policy for repository
description: GitHub Actions cache usage policy for repository.
type: object
@@ -42400,7 +41981,7 @@ paths:
required:
- repo_cache_size_limit_in_gb
examples:
- default: &321
+ default: &318
value:
repo_cache_size_limit_in_gb: 14
x-github:
@@ -42421,8 +42002,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -42430,9 +42011,9 @@ paths:
required: true
content:
application/json:
- schema: *320
+ schema: *317
examples:
- selected_actions: *321
+ selected_actions: *318
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42452,11 +42033,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- - &322
+ - &319
name: ref
description: The full Git reference for narrowing down the cache. The `ref`
for a branch should be formatted as `refs/heads/`. To reference
@@ -42490,7 +42071,7 @@ paths:
description: Response
content:
application/json:
- schema: &323
+ schema: &320
title: Repository actions caches
description: Repository actions caches
type: object
@@ -42532,7 +42113,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &324
+ default: &321
value:
total_count: 1
actions_caches:
@@ -42564,23 +42145,23 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *322
+ - *319
responses:
'200':
description: Response
content:
application/json:
- schema: *323
+ schema: *320
examples:
- default: *324
+ default: *321
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42600,8 +42181,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -42632,9 +42213,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *302
- - *303
- - &325
+ - *299
+ - *300
+ - &322
name: job_id
description: The unique identifier of the job.
in: path
@@ -42646,7 +42227,7 @@ paths:
description: Response
content:
application/json:
- schema: &337
+ schema: &334
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -42953,9 +42534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *302
- - *303
- - *325
+ - *299
+ - *300
+ - *322
responses:
'302':
description: Response
@@ -42983,9 +42564,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *302
- - *303
- - *325
+ - *299
+ - *300
+ - *322
requestBody:
required: false
content:
@@ -43030,8 +42611,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Status response
@@ -43081,8 +42662,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -43145,8 +42726,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -43164,7 +42745,7 @@ paths:
type: integer
secrets:
type: array
- items: &339
+ items: &336
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -43184,7 +42765,7 @@ paths:
- created_at
- updated_at
examples:
- default: &340
+ default: &337
value:
total_count: 2
secrets:
@@ -43217,9 +42798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-organization-variables
parameters:
- - *302
- - *303
- - *326
+ - *299
+ - *300
+ - *323
- *5
responses:
'200':
@@ -43236,7 +42817,7 @@ paths:
type: integer
variables:
type: array
- items: &343
+ items: &340
title: Actions Variable
type: object
properties:
@@ -43266,7 +42847,7 @@ paths:
- created_at
- updated_at
examples:
- default: &344
+ default: &341
value:
total_count: 2
variables:
@@ -43299,8 +42880,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43309,7 +42890,7 @@ paths:
schema:
type: object
properties:
- enabled: &327
+ enabled: &324
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *69
@@ -43342,8 +42923,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -43354,7 +42935,7 @@ paths:
schema:
type: object
properties:
- enabled: *327
+ enabled: *324
allowed_actions: *69
required:
- enabled
@@ -43385,14 +42966,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: &328
+ schema: &325
type: object
properties:
access_level:
@@ -43410,7 +42991,7 @@ paths:
required:
- access_level
examples:
- default: &329
+ default: &326
value:
access_level: organization
x-github:
@@ -43435,15 +43016,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
application/json:
- schema: *328
+ schema: *325
examples:
- default: *329
+ default: *326
responses:
'204':
description: Response
@@ -43467,8 +43048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43499,8 +43080,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -43532,8 +43113,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43562,8 +43143,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Success response
@@ -43603,8 +43184,8 @@ paths:
in: query
schema:
type: string
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -43648,8 +43229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -43681,8 +43262,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -43756,8 +43337,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'201':
description: Response
@@ -43793,8 +43374,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'201':
description: Response
@@ -43824,8 +43405,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'200':
@@ -43855,8 +43436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'204':
@@ -43883,8 +43464,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'200': *87
@@ -43909,8 +43490,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
requestBody:
required: true
@@ -43959,8 +43540,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
requestBody:
required: true
@@ -44010,8 +43591,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
responses:
'200': *165
@@ -44041,8 +43622,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *81
- *166
responses:
@@ -44072,9 +43653,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *302
- - *303
- - &347
+ - *299
+ - *300
+ - &344
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.
@@ -44082,7 +43663,7 @@ paths:
required: false
schema:
type: string
- - &348
+ - &345
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -44090,7 +43671,7 @@ paths:
required: false
schema:
type: string
- - &349
+ - &346
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -44099,7 +43680,7 @@ paths:
required: false
schema:
type: string
- - &350
+ - &347
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
@@ -44126,7 +43707,7 @@ paths:
- pending
- *4
- *5
- - &351
+ - &348
name: created
description: Returns workflow runs created within the given date-time range.
For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -44135,7 +43716,7 @@ paths:
schema:
type: string
format: date-time
- - &330
+ - &327
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -44144,13 +43725,13 @@ paths:
schema:
type: boolean
default: false
- - &352
+ - &349
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &353
+ - &350
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -44173,7 +43754,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &331
+ items: &328
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -44268,7 +43849,7 @@ paths:
that triggered the run.
type: array
nullable: true
- items: &371
+ items: &368
title: Pull Request Minimal
type: object
properties:
@@ -44387,7 +43968,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &375
+ properties: &372
id:
type: string
description: SHA for the commit
@@ -44438,7 +44019,7 @@ paths:
- name
- email
nullable: true
- required: &376
+ required: &373
- id
- tree_id
- message
@@ -44485,7 +44066,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &354
+ default: &351
value:
total_count: 1
workflow_runs:
@@ -44721,24 +44302,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *302
- - *303
- - &332
+ - *299
+ - *300
+ - &329
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *330
+ - *327
responses:
'200':
description: Response
content:
application/json:
- schema: *331
+ schema: *328
examples:
- default: &335
+ default: &332
value:
id: 30433642
name: Build
@@ -44979,9 +44560,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'204':
description: Response
@@ -45004,9 +44585,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'200':
description: Response
@@ -45127,12 +44708,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
- *4
- *5
- - *333
+ - *330
responses:
'200':
description: Response
@@ -45148,9 +44729,9 @@ paths:
type: integer
artifacts:
type: array
- items: *317
+ items: *314
examples:
- default: *334
+ default: *331
headers:
Link: *6
x-github:
@@ -45174,25 +44755,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *302
- - *303
- - *332
- - &336
+ - *299
+ - *300
+ - *329
+ - &333
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *330
+ - *327
responses:
'200':
description: Response
content:
application/json:
- schema: *331
+ schema: *328
examples:
- default: *335
+ default: *332
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -45215,10 +44796,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *302
- - *303
- - *332
- - *336
+ - *299
+ - *300
+ - *329
+ - *333
- *4
- *5
responses:
@@ -45236,9 +44817,9 @@ paths:
type: integer
jobs:
type: array
- items: *337
+ items: *334
examples:
- default: &338
+ default: &335
value:
total_count: 1
jobs:
@@ -45351,10 +44932,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *302
- - *303
- - *332
- - *336
+ - *299
+ - *300
+ - *329
+ - *333
responses:
'302':
description: Response
@@ -45382,9 +44963,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'202':
description: Response
@@ -45417,9 +44998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: true
content:
@@ -45486,9 +45067,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'202':
description: Response
@@ -45521,9 +45102,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
- 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
@@ -45553,9 +45134,9 @@ paths:
type: integer
jobs:
type: array
- items: *337
+ items: *334
examples:
- default: *338
+ default: *335
headers:
Link: *6
x-github:
@@ -45580,9 +45161,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'302':
description: Response
@@ -45609,9 +45190,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'204':
description: Response
@@ -45638,9 +45219,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
responses:
'200':
description: Response
@@ -45700,7 +45281,7 @@ paths:
items:
type: object
properties:
- type: &433
+ type: &430
type: string
description: The type of reviewer.
enum:
@@ -45710,7 +45291,7 @@ paths:
reviewer:
anyOf:
- *19
- - *304
+ - *301
required:
- environment
- wait_timer
@@ -45785,9 +45366,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: true
content:
@@ -45834,7 +45415,7 @@ paths:
application/json:
schema:
type: array
- items: &428
+ items: &425
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -45940,7 +45521,7 @@ paths:
- created_at
- updated_at
examples:
- default: &429
+ default: &426
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -45996,9 +45577,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: false
content:
@@ -46042,9 +45623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *302
- - *303
- - *332
+ - *299
+ - *300
+ - *329
requestBody:
required: false
content:
@@ -46091,8 +45672,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-secrets
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -46110,9 +45691,9 @@ paths:
type: integer
secrets:
type: array
- items: *339
+ items: *336
examples:
- default: *340
+ default: *337
headers:
Link: *6
x-github:
@@ -46137,16 +45718,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *341
+ schema: *338
examples:
- default: *342
+ default: *339
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -46168,17 +45749,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *339
+ schema: *336
examples:
- default: &446
+ default: &443
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -46204,8 +45785,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
requestBody:
required: true
@@ -46263,8 +45844,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'204':
@@ -46290,9 +45871,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-variables
parameters:
- - *302
- - *303
- - *326
+ - *299
+ - *300
+ - *323
- *5
responses:
'200':
@@ -46309,9 +45890,9 @@ paths:
type: integer
variables:
type: array
- items: *343
+ items: *340
examples:
- default: *344
+ default: *341
headers:
Link: *6
x-github:
@@ -46334,8 +45915,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -46387,17 +45968,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: &447
+ default: &444
value:
name: USERNAME
value: octocat
@@ -46423,8 +46004,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
requestBody:
required: true
@@ -46467,8 +46048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-a-repository-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
responses:
'204':
@@ -46494,8 +46075,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#list-repository-workflows
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -46513,7 +46094,7 @@ paths:
type: integer
workflows:
type: array
- items: &345
+ items: &342
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -46620,9 +46201,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#get-a-workflow
parameters:
- - *302
- - *303
- - &346
+ - *299
+ - *300
+ - &343
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -46637,7 +46218,7 @@ paths:
description: Response
content:
application/json:
- schema: *345
+ schema: *342
examples:
default:
value:
@@ -46670,9 +46251,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#disable-a-workflow
parameters:
- - *302
- - *303
- - *346
+ - *299
+ - *300
+ - *343
responses:
'204':
description: Response
@@ -46697,9 +46278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *302
- - *303
- - *346
+ - *299
+ - *300
+ - *343
responses:
'204':
description: Response
@@ -46750,9 +46331,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#enable-a-workflow
parameters:
- - *302
- - *303
- - *346
+ - *299
+ - *300
+ - *343
responses:
'204':
description: Response
@@ -46779,19 +46360,19 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *302
- - *303
+ - *299
+ - *300
+ - *343
+ - *344
+ - *345
- *346
- *347
+ - *4
+ - *5
- *348
+ - *327
- *349
- *350
- - *4
- - *5
- - *351
- - *330
- - *352
- - *353
responses:
'200':
description: Response
@@ -46807,9 +46388,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *331
+ items: *328
examples:
- default: *354
+ default: *351
headers:
Link: *6
x-github:
@@ -46832,8 +46413,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-activities
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *9
- *4
- *88
@@ -46997,8 +46578,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#list-assignees
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -47035,8 +46616,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: assignee
in: path
required: true
@@ -47070,8 +46651,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -47079,7 +46660,7 @@ paths:
application/json:
schema:
type: array
- items: &355
+ items: &352
title: Autolink reference
description: An autolink reference.
type: object
@@ -47133,8 +46714,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -47173,9 +46754,9 @@ paths:
description: response
content:
application/json:
- schema: *355
+ schema: *352
examples:
- default: &356
+ default: &353
value:
id: 1
key_prefix: TICKET-
@@ -47206,9 +46787,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *302
- - *303
- - &357
+ - *299
+ - *300
+ - &354
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -47220,9 +46801,9 @@ paths:
description: Response
content:
application/json:
- schema: *355
+ schema: *352
examples:
- default: *356
+ default: *353
'404': *26
x-github:
githubCloudOnly: false
@@ -47242,9 +46823,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *302
- - *303
- - *357
+ - *299
+ - *300
+ - *354
responses:
'204':
description: Response
@@ -47268,8 +46849,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response if Dependabot is enabled
@@ -47316,8 +46897,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#list-branches
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -47355,7 +46936,7 @@ paths:
- url
protected:
type: boolean
- protection: &359
+ protection: &356
title: Branch Protection
description: Branch Protection
type: object
@@ -47397,7 +46978,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &362
+ enforce_admins: &359
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -47412,7 +46993,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &364
+ required_pull_request_reviews: &361
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -47433,7 +47014,7 @@ paths:
description: The list of teams with review dismissal
access.
type: array
- items: *304
+ items: *301
apps:
description: The list of apps with review dismissal
access.
@@ -47462,7 +47043,7 @@ paths:
description: The list of teams allowed to bypass
pull request requirements.
type: array
- items: *304
+ items: *301
apps:
description: The list of apps allowed to bypass
pull request requirements.
@@ -47488,7 +47069,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &361
+ restrictions: &358
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -47551,7 +47132,7 @@ paths:
type: string
teams:
type: array
- items: *304
+ items: *301
apps:
type: array
items:
@@ -47765,9 +47346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#get-a-branch
parameters:
- - *302
- - *303
- - &360
+ - *299
+ - *300
+ - &357
name: branch
description: The name of the branch. Cannot contain wildcard characters. To
use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.14/graphql).
@@ -47781,14 +47362,14 @@ paths:
description: Response
content:
application/json:
- schema: &370
+ schema: &367
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &406
+ commit: &403
title: Commit
description: Commit
type: object
@@ -47822,7 +47403,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &358
+ properties: &355
name:
type: string
example: '"Chris Wanstrath"'
@@ -47838,7 +47419,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *358
+ properties: *355
nullable: true
message:
type: string
@@ -47859,7 +47440,7 @@ paths:
required:
- sha
- url
- verification: &453
+ verification: &450
title: Verification
type: object
properties:
@@ -47925,7 +47506,7 @@ paths:
type: integer
files:
type: array
- items: &415
+ items: &412
title: Diff Entry
description: Diff Entry
type: object
@@ -48009,7 +47590,7 @@ paths:
- self
protected:
type: boolean
- protection: *359
+ protection: *356
protection_url:
type: string
format: uri
@@ -48113,7 +47694,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *314
+ '301': *311
'404': *26
x-github:
githubCloudOnly: false
@@ -48135,15 +47716,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
default:
value:
@@ -48337,9 +47918,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -48594,7 +48175,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &367
+ required_status_checks: &364
title: Status Check Policy
description: Status Check Policy
type: object
@@ -48670,7 +48251,7 @@ paths:
items: *19
teams:
type: array
- items: *304
+ items: *301
apps:
type: array
items: *25
@@ -48688,7 +48269,7 @@ paths:
items: *19
teams:
type: array
- items: *304
+ items: *301
apps:
type: array
items: *25
@@ -48746,7 +48327,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *361
+ restrictions: *358
required_conversation_resolution:
type: object
properties:
@@ -48858,9 +48439,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -48885,17 +48466,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: &363
+ default: &360
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -48917,17 +48498,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: *363
+ default: *360
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -48946,9 +48527,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -48973,17 +48554,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: &365
+ default: &362
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -49079,9 +48660,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49179,9 +48760,9 @@ paths:
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *365
+ default: *362
'422': *35
x-github:
githubCloudOnly: false
@@ -49202,9 +48783,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49231,17 +48812,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: &366
+ default: &363
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -49264,17 +48845,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *362
+ schema: *359
examples:
- default: *366
+ default: *363
'404': *26
x-github:
githubCloudOnly: false
@@ -49294,9 +48875,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49321,17 +48902,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: &368
+ default: &365
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -49357,9 +48938,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49411,9 +48992,9 @@ paths:
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
- default: *368
+ default: *365
'404': *26
'422': *35
x-github:
@@ -49435,9 +49016,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49461,9 +49042,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -49497,9 +49078,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49566,9 +49147,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -49632,9 +49213,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
content:
application/json:
@@ -49700,15 +49281,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
default:
value:
@@ -49799,9 +49380,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'204':
description: Response
@@ -49824,9 +49405,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -49836,7 +49417,7 @@ paths:
type: array
items: *25
examples:
- default: &369
+ default: &366
value:
- id: 1
slug: octoapp
@@ -49893,9 +49474,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -49929,7 +49510,7 @@ paths:
type: array
items: *25
examples:
- default: *369
+ default: *366
'422': *35
x-github:
githubCloudOnly: false
@@ -49950,9 +49531,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -49986,7 +49567,7 @@ paths:
type: array
items: *25
examples:
- default: *369
+ default: *366
'422': *35
x-github:
githubCloudOnly: false
@@ -50007,9 +49588,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50043,7 +49624,7 @@ paths:
type: array
items: *25
examples:
- default: *369
+ default: *366
'422': *35
x-github:
githubCloudOnly: false
@@ -50065,9 +49646,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -50075,7 +49656,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'404': *26
@@ -50097,9 +49678,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -50135,7 +49716,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'422': *35
@@ -50158,9 +49739,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: false
content:
@@ -50196,7 +49777,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'422': *35
@@ -50219,9 +49800,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
content:
application/json:
@@ -50256,7 +49837,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
'422': *35
@@ -50280,9 +49861,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
responses:
'200':
description: Response
@@ -50316,9 +49897,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50376,9 +49957,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50436,9 +50017,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50498,9 +50079,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#rename-a-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
requestBody:
required: true
content:
@@ -50522,7 +50103,7 @@ paths:
description: Response
content:
application/json:
- schema: *370
+ schema: *367
examples:
default:
value:
@@ -50635,8 +50216,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#create-a-check-run
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -50915,7 +50496,7 @@ paths:
description: Response
content:
application/json:
- schema: &372
+ schema: &369
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -51034,8 +50615,8 @@ paths:
do not necessarily indicate pull requests that triggered the
check.
type: array
- items: *371
- deployment: &628
+ items: *368
+ deployment: &623
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -51315,9 +50896,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#get-a-check-run
parameters:
- - *302
- - *303
- - &373
+ - *299
+ - *300
+ - &370
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -51329,9 +50910,9 @@ paths:
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: &374
+ default: &371
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -51431,9 +51012,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run
parameters:
- - *302
- - *303
- - *373
+ - *299
+ - *300
+ - *370
requestBody:
required: true
content:
@@ -51673,9 +51254,9 @@ paths:
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: *374
+ default: *371
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51695,9 +51276,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-run-annotations
parameters:
- - *302
- - *303
- - *373
+ - *299
+ - *300
+ - *370
- *4
- *5
responses:
@@ -51792,9 +51373,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#rerequest-a-check-run
parameters:
- - *302
- - *303
- - *373
+ - *299
+ - *300
+ - *370
responses:
'201':
description: Response
@@ -51838,8 +51419,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -51861,7 +51442,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &377
+ schema: &374
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -51925,7 +51506,7 @@ paths:
nullable: true
pull_requests:
type: array
- items: *371
+ items: *368
nullable: true
app:
title: GitHub app
@@ -51951,8 +51532,8 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: *375
- required: *376
+ properties: *372
+ required: *373
latest_check_runs_count:
type: integer
check_runs_url:
@@ -51980,7 +51561,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &378
+ default: &375
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -52271,9 +51852,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52292,8 +51873,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -52602,9 +52183,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite
parameters:
- - *302
- - *303
- - &379
+ - *299
+ - *300
+ - &376
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -52616,9 +52197,9 @@ paths:
description: Response
content:
application/json:
- schema: *377
+ schema: *374
examples:
- default: *378
+ default: *375
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52641,17 +52222,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *302
- - *303
- - *379
- - &412
+ - *299
+ - *300
+ - *376
+ - &409
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &413
+ - &410
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -52690,9 +52271,9 @@ paths:
type: integer
check_runs:
type: array
- items: *372
+ items: *369
examples:
- default: &414
+ default: &411
value:
total_count: 1
check_runs:
@@ -52794,9 +52375,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *302
- - *303
- - *379
+ - *299
+ - *300
+ - *376
responses:
'201':
description: Response
@@ -52829,20 +52410,20 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *183
- *184
- *5
- *4
- - &391
+ - &388
name: ref
description: The Git reference for the results you want to list. The `ref`
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
in: query
required: false
- schema: *380
+ schema: *377
- *9
- name: sort
description: The property by which to sort the results.
@@ -52865,7 +52446,7 @@ paths:
be returned.
in: query
required: false
- schema: *381
+ schema: *378
responses:
'200':
description: Response
@@ -52881,7 +52462,7 @@ paths:
updated_at: *100
url: *97
html_url: *98
- instances_url: *382
+ instances_url: *379
state: *92
fixed_at: *102
dismissed_by:
@@ -52892,11 +52473,11 @@ paths:
required: *18
nullable: true
dismissed_at: *101
- dismissed_reason: *383
- dismissed_comment: *384
- rule: *385
- tool: *386
- most_recent_instance: *387
+ dismissed_reason: *380
+ dismissed_comment: *381
+ rule: *382
+ tool: *383
+ most_recent_instance: *384
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -53022,7 +52603,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *42
- '403': &388
+ '403': &385
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -53049,9 +52630,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *302
- - *303
- - &389
+ - *299
+ - *300
+ - &386
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -53065,7 +52646,7 @@ paths:
description: Response
content:
application/json:
- schema: &390
+ schema: &387
type: object
properties:
number: *93
@@ -53073,7 +52654,7 @@ paths:
updated_at: *100
url: *97
html_url: *98
- instances_url: *382
+ instances_url: *379
state: *92
fixed_at: *102
dismissed_by:
@@ -53084,8 +52665,8 @@ paths:
required: *18
nullable: true
dismissed_at: *101
- dismissed_reason: *383
- dismissed_comment: *384
+ dismissed_reason: *380
+ dismissed_comment: *381
rule:
type: object
properties:
@@ -53139,8 +52720,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *386
- most_recent_instance: *387
+ tool: *383
+ most_recent_instance: *384
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -53239,7 +52820,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *42
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53259,9 +52840,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
requestBody:
required: true
content:
@@ -53276,8 +52857,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *383
- dismissed_comment: *384
+ dismissed_reason: *380
+ dismissed_comment: *381
assignees:
description: The list of users to assign to the code scanning alert.
An empty array unassigns all previous assignees from the alert.
@@ -53303,7 +52884,7 @@ paths:
description: Response
content:
application/json:
- schema: *390
+ schema: *387
examples:
default:
value:
@@ -53379,7 +52960,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *34
- '403': &399
+ '403': &396
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -53406,12 +52987,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
- *5
- *4
- - *391
+ - *388
responses:
'200':
description: Response
@@ -53422,10 +53003,10 @@ paths:
items:
type: object
properties:
- ref: *380
- analysis_key: *392
- environment: *393
- category: *394
+ ref: *377
+ analysis_key: *389
+ environment: *390
+ category: *391
state:
type: string
description: State of a code scanning alert instance.
@@ -53440,7 +53021,7 @@ paths:
properties:
text:
type: string
- location: *395
+ location: *392
html_url:
type: string
classifications:
@@ -53448,7 +53029,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: *396
+ items: *393
examples:
default:
value:
@@ -53487,7 +53068,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53521,8 +53102,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *183
- *184
- *5
@@ -53533,12 +53114,12 @@ paths:
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *380
+ schema: *377
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &397
+ schema: &394
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -53559,23 +53140,23 @@ paths:
application/json:
schema:
type: array
- items: &398
+ items: &395
type: object
properties:
- ref: *380
- commit_sha: &400
+ ref: *377
+ commit_sha: &397
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: *392
+ analysis_key: *389
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *394
+ category: *391
error:
type: string
example: error reading field xyz
@@ -53599,8 +53180,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *397
- tool: *386
+ sarif_id: *394
+ tool: *383
deletable:
type: boolean
warning:
@@ -53661,7 +53242,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53697,8 +53278,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -53711,7 +53292,7 @@ paths:
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
response:
summary: application/json response
@@ -53765,7 +53346,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -53847,8 +53428,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -53901,7 +53482,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': *34
- '403': *399
+ '403': *396
'404': *26
'503': *104
x-github:
@@ -53923,8 +53504,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -53986,7 +53567,7 @@ paths:
query_suite: default
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *388
+ '403': *385
'404': *26
'503': *104
x-github:
@@ -54007,8 +53588,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -54079,7 +53660,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *399
+ '403': *396
'404': *26
'409':
description: Response if there is already a validation run in progress with
@@ -54150,8 +53731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -54159,7 +53740,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *400
+ commit_sha: *397
ref:
type: string
description: |-
@@ -54212,7 +53793,7 @@ paths:
schema:
type: object
properties:
- id: *397
+ id: *394
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -54226,7 +53807,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': *399
+ '403': *396
'404': *26
'413':
description: Payload Too Large if the sarif field is too large
@@ -54249,8 +53830,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -54296,7 +53877,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': *388
+ '403': *385
'404':
description: Not Found if the sarif id does not match any upload
'503': *104
@@ -54321,8 +53902,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-codeowners-errors
parameters:
- - *302
- - *303
+ - *299
+ - *300
- 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
@@ -54445,8 +54026,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -54488,7 +54069,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &401
+ properties: &398
login:
type: string
example: octocat
@@ -54581,7 +54162,7 @@ paths:
user_view_type:
type: string
example: public
- required: &402
+ required: &399
- avatar_url
- events_url
- followers_url
@@ -54654,8 +54235,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
responses:
'204':
@@ -54692,8 +54273,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
requestBody:
required: false
@@ -54763,8 +54344,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
responses:
'204':
@@ -54796,8 +54377,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *8
responses:
'200':
@@ -54818,8 +54399,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *401
- required: *402
+ properties: *398
+ required: *399
nullable: true
required:
- permission
@@ -54874,8 +54455,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -54885,7 +54466,7 @@ paths:
application/json:
schema:
type: array
- items: &403
+ items: &400
title: Commit Comment
description: Commit Comment
type: object
@@ -54943,7 +54524,7 @@ paths:
- created_at
- updated_at
examples:
- default: &408
+ default: &405
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55002,17 +54583,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
- default: &409
+ default: &406
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55069,8 +54650,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#update-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -55093,7 +54674,7 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
default:
value:
@@ -55144,8 +54725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#delete-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'204':
@@ -55167,8 +54748,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -55195,7 +54776,7 @@ paths:
application/json:
schema:
type: array
- items: &404
+ items: &401
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -55238,7 +54819,7 @@ paths:
- content
- created_at
examples:
- default: &464
+ default: &461
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -55283,8 +54864,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -55317,9 +54898,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: &405
+ default: &402
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -55348,9 +54929,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -55372,10 +54953,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- - &465
+ - &462
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -55430,8 +55011,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -55487,9 +55068,9 @@ paths:
application/json:
schema:
type: array
- items: *406
+ items: *403
examples:
- default: &513
+ default: &510
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -55582,9 +55163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *302
- - *303
- - &407
+ - *299
+ - *300
+ - &404
name: commit_sha
description: The SHA of the commit.
in: path
@@ -55656,9 +55237,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
- *4
- *5
responses:
@@ -55668,9 +55249,9 @@ paths:
application/json:
schema:
type: array
- items: *403
+ items: *400
examples:
- default: *408
+ default: *405
headers:
Link: *6
x-github:
@@ -55698,9 +55279,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#create-a-commit-comment
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
requestBody:
required: true
content:
@@ -55735,9 +55316,9 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
- default: *409
+ default: *406
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55765,9 +55346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
- *4
- *5
responses:
@@ -55777,7 +55358,7 @@ paths:
application/json:
schema:
type: array
- items: &505
+ items: &502
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -55929,7 +55510,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *304
+ items: *301
nullable: true
head:
type: object
@@ -55998,7 +55579,7 @@ paths:
- review_comment
- self
author_association: *110
- auto_merge: *410
+ auto_merge: *407
draft:
description: Indicates whether or not the pull request is a
draft.
@@ -56037,7 +55618,7 @@ paths:
- author_association
- auto_merge
examples:
- default: &506
+ default: &503
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -56574,11 +56155,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#get-a-commit
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *5
- *4
- - &411
+ - &408
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)"
@@ -56593,9 +56174,9 @@ paths:
description: Response
content:
application/json:
- schema: *406
+ schema: *403
examples:
- default: &490
+ default: &487
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -56705,11 +56286,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *302
- - *303
- - *411
- - *412
- - *413
+ - *299
+ - *300
+ - *408
+ - *409
+ - *410
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -56743,9 +56324,9 @@ paths:
type: integer
check_runs:
type: array
- items: *372
+ items: *369
examples:
- default: *414
+ default: *411
headers:
Link: *6
x-github:
@@ -56770,9 +56351,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *302
- - *303
- - *411
+ - *299
+ - *300
+ - *408
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -56780,7 +56361,7 @@ paths:
schema:
type: integer
example: 1
- - *412
+ - *409
- *4
- *5
responses:
@@ -56798,7 +56379,7 @@ paths:
type: integer
check_suites:
type: array
- items: *377
+ items: *374
examples:
default:
value:
@@ -56998,9 +56579,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *302
- - *303
- - *411
+ - *299
+ - *300
+ - *408
- *4
- *5
responses:
@@ -57198,9 +56779,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *302
- - *303
- - *411
+ - *299
+ - *300
+ - *408
- *4
- *5
responses:
@@ -57210,7 +56791,7 @@ paths:
application/json:
schema:
type: array
- items: &546
+ items: &543
title: Status
description: The status of a commit.
type: object
@@ -57291,7 +56872,7 @@ paths:
site_admin: false
headers:
Link: *6
- '301': *314
+ '301': *311
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57359,8 +56940,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#compare-two-commits
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *5
- *4
- name: basehead
@@ -57403,8 +56984,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *406
- merge_base_commit: *406
+ base_commit: *403
+ merge_base_commit: *403
status:
type: string
enum:
@@ -57424,10 +57005,10 @@ paths:
example: 6
commits:
type: array
- items: *406
+ items: *403
files:
type: array
- items: *415
+ items: *412
required:
- url
- html_url
@@ -57706,8 +57287,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-repository-content
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: path
description: path parameter
in: path
@@ -57850,7 +57431,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &416
+ response-if-content-is-a-file: &413
summary: Response if content is a file
value:
type: file
@@ -57982,7 +57563,7 @@ paths:
- size
- type
- url
- - &518
+ - &515
title: Content File
description: Content File
type: object
@@ -58183,7 +57764,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *416
+ response-if-content-is-a-file: *413
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -58252,7 +57833,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *26
'403': *43
- '302': &522
+ '302': &519
description: Found
'304': *42
x-github:
@@ -58276,8 +57857,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#create-or-update-file-contents
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: path
description: path parameter
in: path
@@ -58370,7 +57951,7 @@ paths:
description: Response
content:
application/json:
- schema: &417
+ schema: &414
title: File Commit
description: File Commit
type: object
@@ -58516,7 +58097,7 @@ paths:
description: Response
content:
application/json:
- schema: *417
+ schema: *414
examples:
example-for-creating-a-file:
value:
@@ -58567,7 +58148,7 @@ paths:
schema:
oneOf:
- *24
- - &448
+ - &445
description: Repository rule violation was detected
type: object
properties:
@@ -58620,8 +58201,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#delete-a-file
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: path
description: path parameter
in: path
@@ -58682,7 +58263,7 @@ paths:
description: Response
content:
application/json:
- schema: *417
+ schema: *414
examples:
default:
value:
@@ -58733,8 +58314,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-contributors
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -58857,8 +58438,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *191
- *192
- *193
@@ -58870,7 +58451,7 @@ paths:
schema:
type: string
- *195
- - *418
+ - *415
- *196
- *197
- *9
@@ -58901,7 +58482,7 @@ paths:
application/json:
schema:
type: array
- items: &422
+ items: &419
type: object
description: A Dependabot alert.
properties:
@@ -58934,7 +58515,7 @@ paths:
enum:
- development
- runtime
- security_advisory: *419
+ security_advisory: *416
security_vulnerability: *96
url: *97
html_url: *98
@@ -58965,8 +58546,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *102
- auto_dismissed_at: *420
- dismissal_request: *421
+ auto_dismissed_at: *417
+ dismissal_request: *418
required:
- number
- state
@@ -59193,9 +58774,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *302
- - *303
- - &423
+ - *299
+ - *300
+ - &420
name: alert_number
in: path
description: |-
@@ -59210,7 +58791,7 @@ paths:
description: Response
content:
application/json:
- schema: *422
+ schema: *419
examples:
default:
value:
@@ -59314,9 +58895,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *302
- - *303
- - *423
+ - *299
+ - *300
+ - *420
requestBody:
required: true
content:
@@ -59361,7 +58942,7 @@ paths:
description: Response
content:
application/json:
- schema: *422
+ schema: *419
examples:
default:
value:
@@ -59490,8 +59071,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -59509,7 +59090,7 @@ paths:
type: integer
secrets:
type: array
- items: &426
+ items: &423
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -59562,16 +59143,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *424
+ schema: *421
examples:
- default: *425
+ default: *422
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59591,15 +59172,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *426
+ schema: *423
examples:
default:
value:
@@ -59625,8 +59206,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
requestBody:
required: true
@@ -59679,8 +59260,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *168
responses:
'204':
@@ -59703,8 +59284,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *302
- - *303
+ - *299
+ - *300
- 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
@@ -59864,8 +59445,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -60090,8 +59671,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -60166,7 +59747,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &427
+ metadata: &424
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -60199,7 +59780,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *427
+ metadata: *424
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -60212,7 +59793,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *427
+ metadata: *424
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -60341,8 +59922,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -60382,9 +59963,9 @@ paths:
application/json:
schema:
type: array
- items: *428
+ items: *425
examples:
- default: *429
+ default: *426
headers:
Link: *6
x-github:
@@ -60450,8 +60031,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#create-a-deployment
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -60532,7 +60113,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
simple-example:
summary: Simple example
@@ -60605,9 +60186,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#get-a-deployment
parameters:
- - *302
- - *303
- - &430
+ - *299
+ - *300
+ - &427
name: deployment_id
description: deployment_id parameter
in: path
@@ -60619,7 +60200,7 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
default:
value:
@@ -60684,9 +60265,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#delete-a-deployment
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
responses:
'204':
description: Response
@@ -60708,9 +60289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
- *4
- *5
responses:
@@ -60720,7 +60301,7 @@ paths:
application/json:
schema:
type: array
- items: &431
+ items: &428
title: Deployment Status
description: The status of a deployment.
type: object
@@ -60881,9 +60462,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
requestBody:
required: true
content:
@@ -60958,9 +60539,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: &432
+ default: &429
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -61016,9 +60597,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *302
- - *303
- - *430
+ - *299
+ - *300
+ - *427
- name: status_id
in: path
required: true
@@ -61029,9 +60610,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: *432
+ default: *429
'404': *26
x-github:
githubCloudOnly: false
@@ -61056,8 +60637,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -61114,8 +60695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#list-environments
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -61132,7 +60713,7 @@ paths:
type: integer
environments:
type: array
- items: &434
+ items: &431
title: Environment
description: Details of a deployment environment
type: object
@@ -61184,7 +60765,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &436
+ wait_timer: &433
type: integer
example: 30
description: The amount of time to delay a job after
@@ -61221,11 +60802,11 @@ paths:
items:
type: object
properties:
- type: *433
+ type: *430
reviewer:
anyOf:
- *19
- - *304
+ - *301
required:
- id
- node_id
@@ -61245,7 +60826,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &437
+ deployment_branch_policy: &434
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -61360,9 +60941,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#get-an-environment
parameters:
- - *302
- - *303
- - &435
+ - *299
+ - *300
+ - &432
name: environment_name
in: path
required: true
@@ -61375,9 +60956,9 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *431
examples:
- default: &438
+ default: &435
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -61460,9 +61041,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
requestBody:
required: false
content:
@@ -61471,7 +61052,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *436
+ wait_timer: *433
prevent_self_review:
type: boolean
example: false
@@ -61488,13 +61069,13 @@ paths:
items:
type: object
properties:
- type: *433
+ type: *430
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *437
+ deployment_branch_policy: *434
additionalProperties: false
examples:
default:
@@ -61514,9 +61095,9 @@ paths:
description: Response
content:
application/json:
- schema: *434
+ schema: *431
examples:
- default: *438
+ default: *435
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -61540,9 +61121,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#delete-an-environment
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
responses:
'204':
description: Default response
@@ -61567,9 +61148,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *4
- *5
responses:
@@ -61587,7 +61168,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &439
+ items: &436
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -61644,9 +61225,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
requestBody:
required: true
content:
@@ -61692,9 +61273,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- example-wildcard: &440
+ example-wildcard: &437
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -61736,10 +61317,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
- - &441
+ - *299
+ - *300
+ - *432
+ - &438
name: branch_policy_id
in: path
required: true
@@ -61751,9 +61332,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61772,10 +61353,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
- - *441
+ - *299
+ - *300
+ - *432
+ - *438
requestBody:
required: true
content:
@@ -61803,9 +61384,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *440
+ default: *437
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61824,10 +61405,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *302
- - *303
- - *435
- - *441
+ - *299
+ - *300
+ - *432
+ - *438
responses:
'204':
description: Response
@@ -61852,9 +61433,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *435
- - *303
- - *302
+ - *432
+ - *300
+ - *299
responses:
'200':
description: List of deployment protection rules
@@ -61870,7 +61451,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &442
+ items: &439
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -61889,7 +61470,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &443
+ app: &440
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -61988,9 +61569,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *435
- - *303
- - *302
+ - *432
+ - *300
+ - *299
requestBody:
content:
application/json:
@@ -62011,9 +61592,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: &444
+ default: &441
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -62048,9 +61629,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *435
- - *303
- - *302
+ - *432
+ - *300
+ - *299
- *5
- *4
responses:
@@ -62069,7 +61650,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *443
+ items: *440
examples:
default:
value:
@@ -62104,10 +61685,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *302
- - *303
- - *435
- - &445
+ - *299
+ - *300
+ - *432
+ - &442
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -62119,9 +61700,9 @@ paths:
description: Response
content:
application/json:
- schema: *442
+ schema: *439
examples:
- default: *444
+ default: *441
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62142,10 +61723,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *435
- - *303
- - *302
- - *445
+ - *432
+ - *300
+ - *299
+ - *442
responses:
'204':
description: Response
@@ -62171,9 +61752,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-environment-secrets
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *4
- *5
responses:
@@ -62191,9 +61772,9 @@ paths:
type: integer
secrets:
type: array
- items: *339
+ items: *336
examples:
- default: *340
+ default: *337
headers:
Link: *6
x-github:
@@ -62218,17 +61799,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
responses:
'200':
description: Response
content:
application/json:
- schema: *341
+ schema: *338
examples:
- default: *342
+ default: *339
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62250,18 +61831,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-secret
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *339
+ schema: *336
examples:
- default: *446
+ default: *443
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62283,9 +61864,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *168
requestBody:
required: true
@@ -62343,9 +61924,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *168
responses:
'204':
@@ -62371,10 +61952,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-environment-variables
parameters:
- - *302
- - *303
- - *435
- - *326
+ - *299
+ - *300
+ - *432
+ - *323
- *5
responses:
'200':
@@ -62391,9 +61972,9 @@ paths:
type: integer
variables:
type: array
- items: *343
+ items: *340
examples:
- default: *344
+ default: *341
headers:
Link: *6
x-github:
@@ -62416,9 +61997,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-an-environment-variable
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
requestBody:
required: true
content:
@@ -62470,18 +62051,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-an-environment-variable
parameters:
- - *302
- - *303
- - *435
+ - *299
+ - *300
+ - *432
- *171
responses:
'200':
description: Response
content:
application/json:
- schema: *343
+ schema: *340
examples:
- default: *447
+ default: *444
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62502,10 +62083,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-an-environment-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
- - *435
+ - *432
requestBody:
required: true
content:
@@ -62547,10 +62128,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-an-environment-variable
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *171
- - *435
+ - *432
responses:
'204':
description: Response
@@ -62572,8 +62153,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-repository-events
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -62651,8 +62232,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#list-forks
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -62811,8 +62392,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#create-a-fork
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -62844,9 +62425,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
+ default: *312
'400': *34
'422': *35
'403': *43
@@ -62867,8 +62448,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#create-a-blob
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -62928,7 +62509,7 @@ paths:
schema:
oneOf:
- *143
- - *448
+ - *445
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62953,8 +62534,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#get-a-blob
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: file_sha
in: path
required: true
@@ -63053,8 +62634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -63163,7 +62744,7 @@ paths:
description: Response
content:
application/json:
- schema: &449
+ schema: &446
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -63370,15 +62951,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#get-a-commit-object
parameters:
- - *302
- - *303
- - *407
+ - *299
+ - *300
+ - *404
responses:
'200':
description: Response
content:
application/json:
- schema: *449
+ schema: *446
examples:
default:
value:
@@ -63431,9 +63012,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#list-matching-references
parameters:
- - *302
- - *303
- - &450
+ - *299
+ - *300
+ - &447
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.
@@ -63450,7 +63031,7 @@ paths:
application/json:
schema:
type: array
- items: &451
+ items: &448
title: Git Reference
description: Git references within a repository
type: object
@@ -63525,17 +63106,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference
parameters:
- - *302
- - *303
- - *450
+ - *299
+ - *300
+ - *447
responses:
'200':
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: &452
+ default: &449
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -63564,8 +63145,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -63594,9 +63175,9 @@ paths:
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: *452
+ default: *449
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -63622,9 +63203,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference
parameters:
- - *302
- - *303
- - *450
+ - *299
+ - *300
+ - *447
requestBody:
required: true
content:
@@ -63653,9 +63234,9 @@ paths:
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: *452
+ default: *449
'422': *35
'409': *145
x-github:
@@ -63673,9 +63254,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#delete-a-reference
parameters:
- - *302
- - *303
- - *450
+ - *299
+ - *300
+ - *447
responses:
'204':
description: Response
@@ -63730,8 +63311,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#create-a-tag-object
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -63798,7 +63379,7 @@ paths:
description: Response
content:
application/json:
- schema: &454
+ schema: &451
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -63849,7 +63430,7 @@ paths:
- sha
- type
- url
- verification: *453
+ verification: *450
required:
- sha
- url
@@ -63859,7 +63440,7 @@ paths:
- tag
- message
examples:
- default: &455
+ default: &452
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -63929,8 +63510,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#get-a-tag
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tag_sha
in: path
required: true
@@ -63941,9 +63522,9 @@ paths:
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
'404': *26
'409': *145
x-github:
@@ -63967,8 +63548,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#create-a-tree
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -64041,7 +63622,7 @@ paths:
description: Response
content:
application/json:
- schema: &456
+ schema: &453
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -64137,8 +63718,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -64161,7 +63742,7 @@ paths:
description: Response
content:
application/json:
- schema: *456
+ schema: *453
examples:
default-response:
summary: Default response
@@ -64220,8 +63801,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -64231,7 +63812,7 @@ paths:
application/json:
schema:
type: array
- items: &457
+ items: &454
title: Webhook
description: Webhooks for repositories.
type: object
@@ -64285,7 +63866,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &658
+ last_response: &653
title: Hook Response
type: object
properties:
@@ -64359,8 +63940,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -64412,9 +63993,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: &458
+ default: &455
value:
type: Repository
id: 12345678
@@ -64462,17 +64043,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'200':
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
'404': *26
x-github:
githubCloudOnly: false
@@ -64492,8 +64073,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
requestBody:
required: true
@@ -64539,9 +64120,9 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
- default: *458
+ default: *455
'422': *35
'404': *26
x-github:
@@ -64562,8 +64143,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'204':
@@ -64588,8 +64169,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'200':
@@ -64617,8 +64198,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
requestBody:
required: false
@@ -64663,8 +64244,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
- *4
- *207
@@ -64696,8 +64277,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
- *36
responses:
@@ -64726,8 +64307,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
- *36
responses:
@@ -64751,8 +64332,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'204':
@@ -64778,8 +64359,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *3
responses:
'204':
@@ -64804,8 +64385,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -64813,8 +64394,8 @@ paths:
application/json:
schema: *39
examples:
- default: *459
- '301': *314
+ default: *456
+ '301': *311
'404': *26
x-github:
githubCloudOnly: false
@@ -64833,8 +64414,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -64844,7 +64425,7 @@ paths:
application/json:
schema:
type: array
- items: &460
+ items: &457
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -64907,7 +64488,7 @@ paths:
- html_url
- created_at
examples:
- default: &607
+ default: &602
value:
- id: 1
repository:
@@ -65038,9 +64619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *302
- - *303
- - &461
+ - *299
+ - *300
+ - &458
name: invitation_id
description: The unique identifier of the invitation.
in: path
@@ -65075,7 +64656,7 @@ paths:
description: Response
content:
application/json:
- schema: *460
+ schema: *457
examples:
default:
value:
@@ -65206,9 +64787,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *302
- - *303
- - *461
+ - *299
+ - *300
+ - *458
responses:
'204':
description: Response
@@ -65239,8 +64820,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-repository-issues
parameters:
- - *302
- - *303
+ - *299
+ - *300
- 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
@@ -65461,7 +65042,7 @@ paths:
state_reason: completed
headers:
Link: *6
- '301': *314
+ '301': *311
'422': *35
'404': *26
x-github:
@@ -65490,8 +65071,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#create-an-issue
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -65575,7 +65156,7 @@ paths:
application/json:
schema: *109
examples:
- default: &469
+ default: &466
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -65759,9 +65340,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *302
- - *303
- - &511
+ - *299
+ - *300
+ - &508
name: sort
description: The property to sort the results by.
in: query
@@ -65791,9 +65372,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: &471
+ default: &468
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -65851,17 +65432,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: &463
+ default: &460
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -65915,8 +65496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#update-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -65939,9 +65520,9 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
'422': *35
x-github:
githubCloudOnly: false
@@ -65959,8 +65540,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#delete-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'204':
@@ -65981,8 +65562,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -66009,9 +65590,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -66032,8 +65613,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -66066,16 +65647,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -66097,10 +65678,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- - *465
+ - *462
responses:
'204':
description: Response
@@ -66120,8 +65701,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -66131,7 +65712,7 @@ paths:
application/json:
schema:
type: array
- items: &468
+ items: &465
title: Issue Event
description: Issue Event
type: object
@@ -66174,8 +65755,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *466
- required: *467
+ properties: *463
+ required: *464
nullable: true
label:
title: Issue Event Label
@@ -66219,7 +65800,7 @@ paths:
properties: *17
required: *18
nullable: true
- requested_team: *304
+ requested_team: *301
dismissed_review:
title: Issue Event Dismissed Review
type: object
@@ -66482,8 +66063,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#get-an-issue-event
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: event_id
in: path
required: true
@@ -66494,7 +66075,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -66720,9 +66301,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue
parameters:
- - *302
- - *303
- - &470
+ - *299
+ - *300
+ - &467
name: issue_number
description: The number that identifies the issue.
in: path
@@ -66736,8 +66317,8 @@ paths:
application/json:
schema: *109
examples:
- default: *469
- '301': *314
+ default: *466
+ '301': *311
'404': *26
'410': *243
'304': *42
@@ -66764,9 +66345,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#update-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -66872,11 +66453,11 @@ paths:
application/json:
schema: *109
examples:
- default: *469
+ default: *466
'422': *35
'503': *104
'403': *43
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -66896,9 +66477,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -66926,7 +66507,7 @@ paths:
application/json:
schema: *109
examples:
- default: *469
+ default: *466
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66942,9 +66523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
content:
application/json:
@@ -66971,7 +66552,7 @@ paths:
application/json:
schema: *109
examples:
- default: *469
+ default: *466
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66993,9 +66574,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- name: assignee
in: path
required: true
@@ -67035,9 +66616,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *119
- *4
- *5
@@ -67048,9 +66629,9 @@ paths:
application/json:
schema:
type: array
- items: *462
+ items: *459
examples:
- default: *471
+ default: *468
headers:
Link: *6
'404': *26
@@ -67083,9 +66664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: true
content:
@@ -67107,9 +66688,9 @@ paths:
description: Response
content:
application/json:
- schema: *462
+ schema: *459
examples:
- default: *463
+ default: *460
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
@@ -67136,9 +66717,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *4
- *5
responses:
@@ -67152,7 +66733,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &473
+ - &470
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -67206,7 +66787,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &474
+ - &471
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -67342,7 +66923,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &475
+ - &472
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -67393,7 +66974,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &476
+ - &473
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -67444,7 +67025,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &477
+ - &474
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -67498,7 +67079,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &478
+ - &475
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -67532,7 +67113,7 @@ paths:
properties: *106
required: *107
review_requester: *19
- requested_team: *304
+ requested_team: *301
requested_reviewer: *19
required:
- review_requester
@@ -67545,7 +67126,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &479
+ - &476
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -67579,7 +67160,7 @@ paths:
properties: *106
required: *107
review_requester: *19
- requested_team: *304
+ requested_team: *301
requested_reviewer: *19
required:
- review_requester
@@ -67592,7 +67173,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &480
+ - &477
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -67652,7 +67233,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &481
+ - &478
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -67700,7 +67281,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &482
+ - &479
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -67766,7 +67347,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &483
+ - &480
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -67832,7 +67413,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &484
+ - &481
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -67898,7 +67479,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &485
+ - &482
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -68006,9 +67587,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *4
- *5
responses:
@@ -68020,7 +67601,7 @@ paths:
type: array
items: *108
examples:
- default: &472
+ default: &469
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -68038,7 +67619,7 @@ paths:
default: false
headers:
Link: *6
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -68057,9 +67638,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -68120,8 +67701,8 @@ paths:
type: array
items: *108
examples:
- default: *472
- '301': *314
+ default: *469
+ '301': *311
'404': *26
'410': *243
'422': *35
@@ -68140,9 +67721,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -68204,8 +67785,8 @@ paths:
type: array
items: *108
examples:
- default: *472
- '301': *314
+ default: *469
+ '301': *311
'404': *26
'410': *243
'422': *35
@@ -68224,13 +67805,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
responses:
'204':
description: Response
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -68251,9 +67832,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- name: name
in: path
required: true
@@ -68277,7 +67858,7 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *314
+ '301': *311
'404': *26
'410': *243
x-github:
@@ -68299,9 +67880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#lock-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: false
content:
@@ -68347,9 +67928,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#unlock-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
responses:
'204':
description: Response
@@ -68371,9 +67952,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -68399,9 +67980,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -68423,9 +68004,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
requestBody:
required: true
content:
@@ -68457,16 +68038,16 @@ paths:
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -68488,10 +68069,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *302
- - *303
- - *470
- - *465
+ - *299
+ - *300
+ - *467
+ - *462
responses:
'204':
description: Response
@@ -68511,9 +68092,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *302
- - *303
- - *470
+ - *299
+ - *300
+ - *467
- *4
- *5
responses:
@@ -68528,6 +68109,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *470
+ - *471
+ - *472
- *473
- *474
- *475
@@ -68538,9 +68122,6 @@ paths:
- *480
- *481
- *482
- - *483
- - *484
- - *485
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -68845,7 +68426,7 @@ paths:
type: string
comments:
type: array
- items: &507
+ items: &504
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -69054,7 +68635,7 @@ paths:
type: string
comments:
type: array
- items: *403
+ items: *400
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -69360,8 +68941,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -69371,7 +68952,7 @@ paths:
application/json:
schema:
type: array
- items: &486
+ items: &483
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -69435,8 +69016,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -69472,9 +69053,9 @@ paths:
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
- default: &487
+ default: &484
value:
id: 1
key: ssh-rsa AAA...
@@ -69507,9 +69088,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *302
- - *303
- - &488
+ - *299
+ - *300
+ - &485
name: key_id
description: The unique identifier of the key.
in: path
@@ -69521,9 +69102,9 @@ paths:
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
- default: *487
+ default: *484
'404': *26
x-github:
githubCloudOnly: false
@@ -69541,9 +69122,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *302
- - *303
- - *488
+ - *299
+ - *300
+ - *485
responses:
'204':
description: Response
@@ -69563,8 +69144,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -69576,7 +69157,7 @@ paths:
type: array
items: *108
examples:
- default: *472
+ default: *469
headers:
Link: *6
'404': *26
@@ -69597,8 +69178,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#create-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -69636,7 +69217,7 @@ paths:
application/json:
schema: *108
examples:
- default: &489
+ default: &486
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -69668,8 +69249,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#get-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: name
in: path
required: true
@@ -69682,7 +69263,7 @@ paths:
application/json:
schema: *108
examples:
- default: *489
+ default: *486
'404': *26
x-github:
githubCloudOnly: false
@@ -69699,8 +69280,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#update-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: name
in: path
required: true
@@ -69765,8 +69346,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#delete-a-label
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: name
in: path
required: true
@@ -69792,8 +69373,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-languages
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -69829,8 +69410,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'202': *146
'403':
@@ -69858,8 +69439,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -69885,9 +69466,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *302
- - *303
- - *391
+ - *299
+ - *300
+ - *388
responses:
'200':
description: Response
@@ -70032,8 +69613,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70098,8 +69679,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#merge-a-branch
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70133,9 +69714,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *406
+ schema: *403
examples:
- default: *490
+ default: *487
'204':
description: Response when already merged
'404':
@@ -70160,8 +69741,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#list-milestones
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -70202,7 +69783,7 @@ paths:
application/json:
schema:
type: array
- items: &491
+ items: &488
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -70263,8 +69844,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#create-a-milestone
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70304,9 +69885,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: &492
+ default: &489
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -70365,9 +69946,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#get-a-milestone
parameters:
- - *302
- - *303
- - &493
+ - *299
+ - *300
+ - &490
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -70379,9 +69960,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: *492
+ default: *489
'404': *26
x-github:
githubCloudOnly: false
@@ -70398,9 +69979,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#update-a-milestone
parameters:
- - *302
- - *303
- - *493
+ - *299
+ - *300
+ - *490
requestBody:
required: false
content:
@@ -70438,9 +70019,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: *492
+ default: *489
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70456,9 +70037,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#delete-a-milestone
parameters:
- - *302
- - *303
- - *493
+ - *299
+ - *300
+ - *490
responses:
'204':
description: Response
@@ -70479,9 +70060,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *302
- - *303
- - *493
+ - *299
+ - *300
+ - *490
- *4
- *5
responses:
@@ -70493,7 +70074,7 @@ paths:
type: array
items: *108
examples:
- default: *472
+ default: *469
headers:
Link: *6
x-github:
@@ -70512,12 +70093,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *302
- - *303
- - *494
- - *495
+ - *299
+ - *300
+ - *491
+ - *492
- *119
- - *496
+ - *493
- *4
- *5
responses:
@@ -70529,7 +70110,7 @@ paths:
type: array
items: *136
examples:
- default: *497
+ default: *494
headers:
Link: *6
x-github:
@@ -70553,8 +70134,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -70612,14 +70193,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: &498
+ schema: &495
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -70744,7 +70325,7 @@ paths:
- custom_404
- public
examples:
- default: &499
+ default: &496
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -70785,8 +70366,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70840,9 +70421,9 @@ paths:
description: Response
content:
application/json:
- schema: *498
+ schema: *495
examples:
- default: *499
+ default: *496
'422': *35
'409': *145
x-github:
@@ -70865,8 +70446,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -70965,8 +70546,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -70992,8 +70573,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -71003,7 +70584,7 @@ paths:
application/json:
schema:
type: array
- items: &500
+ items: &497
title: Page Build
description: Page Build
type: object
@@ -71097,8 +70678,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'201':
description: Response
@@ -71143,16 +70724,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-latest-pages-build
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *500
+ schema: *497
examples:
- default: &501
+ default: &498
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -71200,8 +70781,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-apiname-pages-build
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: build_id
in: path
required: true
@@ -71212,9 +70793,9 @@ paths:
description: Response
content:
application/json:
- schema: *500
+ schema: *497
examples:
- default: *501
+ default: *498
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71234,8 +70815,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71335,9 +70916,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *302
- - *303
- - &502
+ - *299
+ - *300
+ - &499
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -71395,9 +70976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *302
- - *303
- - *502
+ - *299
+ - *300
+ - *499
responses:
'204': *239
'404': *26
@@ -71420,8 +71001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- *9
@@ -71442,7 +71023,7 @@ paths:
application/json:
schema:
type: array
- items: &503
+ items: &500
type: object
properties:
id:
@@ -71476,17 +71057,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: &504
+ default: &501
value:
id: 42
name: Check Commits
@@ -71508,15 +71089,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *503
+ schema: *500
examples:
default:
value:
@@ -71560,8 +71141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *16
responses:
'200':
@@ -71569,9 +71150,9 @@ paths:
global level.
content:
application/json:
- schema: *503
+ schema: *500
examples:
- default: *504
+ default: *501
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71591,8 +71172,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#list-repository-projects
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: state
description: Indicates the state of the projects to return.
in: query
@@ -71677,8 +71258,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#create-a-repository-project
deprecated: true
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71706,7 +71287,7 @@ paths:
application/json:
schema: *242
examples:
- default: *311
+ default: *308
'401': *41
'403': *43
'404': *26
@@ -71730,8 +71311,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -71770,8 +71351,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71833,8 +71414,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -71894,9 +71475,9 @@ paths:
application/json:
schema:
type: array
- items: *505
+ items: *502
examples:
- default: *506
+ default: *503
headers:
Link: *6
'304': *42
@@ -71928,8 +71509,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#create-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -71996,7 +71577,7 @@ paths:
application/json:
schema: *117
examples:
- default: &509
+ default: &506
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -72523,8 +72104,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sort
in: query
required: false
@@ -72553,9 +72134,9 @@ paths:
application/json:
schema:
type: array
- items: *507
+ items: *504
examples:
- default: &512
+ default: &509
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -72632,17 +72213,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: &508
+ default: &505
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -72717,8 +72298,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -72741,9 +72322,9 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: *508
+ default: *505
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72759,8 +72340,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
responses:
'204':
@@ -72782,8 +72363,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -72810,9 +72391,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -72833,8 +72414,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
requestBody:
required: true
@@ -72867,16 +72448,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -72898,10 +72479,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *128
- - *465
+ - *462
responses:
'204':
description: Response
@@ -72944,9 +72525,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request
parameters:
- - *302
- - *303
- - &510
+ - *299
+ - *300
+ - &507
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -72961,7 +72542,7 @@ paths:
application/json:
schema: *117
examples:
- default: *509
+ default: *506
'304': *42
'404': *26
'406':
@@ -72996,9 +72577,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -73042,7 +72623,7 @@ paths:
application/json:
schema: *117
examples:
- default: *509
+ default: *506
'422': *35
'403': *43
x-github:
@@ -73070,10 +72651,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *511
+ - *299
+ - *300
+ - *507
+ - *508
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
in: query
@@ -73093,9 +72674,9 @@ paths:
application/json:
schema:
type: array
- items: *507
+ items: *504
examples:
- default: *512
+ default: *509
headers:
Link: *6
x-github:
@@ -73128,9 +72709,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: true
content:
@@ -73235,7 +72816,7 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
example-for-a-multi-line-comment:
value:
@@ -73323,9 +72904,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *128
requestBody:
required: true
@@ -73348,7 +72929,7 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
default:
value:
@@ -73434,9 +73015,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *4
- *5
responses:
@@ -73446,9 +73027,9 @@ paths:
application/json:
schema:
type: array
- items: *406
+ items: *403
examples:
- default: *513
+ default: *510
headers:
Link: *6
x-github:
@@ -73478,9 +73059,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *4
- *5
responses:
@@ -73490,7 +73071,7 @@ paths:
application/json:
schema:
type: array
- items: *415
+ items: *412
examples:
default:
value:
@@ -73528,9 +73109,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
responses:
'204':
description: Response if pull request has been merged
@@ -73553,9 +73134,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -73666,9 +73247,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
responses:
'200':
description: Response
@@ -73684,7 +73265,7 @@ paths:
items: *19
teams:
type: array
- items: *304
+ items: *301
required:
- users
- teams
@@ -73743,9 +73324,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -73782,7 +73363,7 @@ paths:
description: Response
content:
application/json:
- schema: *505
+ schema: *502
examples:
default:
value:
@@ -74318,9 +73899,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: true
content:
@@ -74354,7 +73935,7 @@ paths:
description: Response
content:
application/json:
- schema: *505
+ schema: *502
examples:
default:
value:
@@ -74859,9 +74440,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
- *4
- *5
responses:
@@ -74871,7 +74452,7 @@ paths:
application/json:
schema:
type: array
- items: &514
+ items: &511
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -75022,9 +74603,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -75110,9 +74691,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &516
+ default: &513
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -75175,10 +74756,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - &515
+ - *299
+ - *300
+ - *507
+ - &512
name: review_id
description: The unique identifier of the review.
in: path
@@ -75190,9 +74771,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &517
+ default: &514
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -75251,10 +74832,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
requestBody:
required: true
content:
@@ -75277,7 +74858,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -75339,18 +74920,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *516
+ default: *513
'422': *27
'404': *26
x-github:
@@ -75377,10 +74958,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
- *4
- *5
responses:
@@ -75615,10 +75196,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
requestBody:
required: true
content:
@@ -75646,7 +75227,7 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
default:
value:
@@ -75709,10 +75290,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *302
- - *303
- - *510
- - *515
+ - *299
+ - *300
+ - *507
+ - *512
requestBody:
required: true
content:
@@ -75747,9 +75328,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *517
+ default: *514
'404': *26
'422': *27
'403': *43
@@ -75771,9 +75352,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *302
- - *303
- - *510
+ - *299
+ - *300
+ - *507
requestBody:
required: false
content:
@@ -75836,8 +75417,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -75850,9 +75431,9 @@ paths:
description: Response
content:
application/json:
- schema: *518
+ schema: *515
examples:
- default: &519
+ default: &516
value:
type: file
encoding: base64
@@ -75894,8 +75475,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: dir
description: The alternate path to look for a README file
in: path
@@ -75915,9 +75496,9 @@ paths:
description: Response
content:
application/json:
- schema: *518
+ schema: *515
examples:
- default: *519
+ default: *516
'404': *26
'422': *35
x-github:
@@ -75939,8 +75520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#list-releases
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -75950,7 +75531,7 @@ paths:
application/json:
schema:
type: array
- items: *520
+ items: *517
examples:
default:
value:
@@ -76044,8 +75625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -76115,9 +75696,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: &525
+ default: &522
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -76217,9 +75798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#get-a-release-asset
parameters:
- - *302
- - *303
- - &523
+ - *299
+ - *300
+ - &520
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -76231,9 +75812,9 @@ paths:
description: Response
content:
application/json:
- schema: *521
+ schema: *518
examples:
- default: &524
+ default: &521
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
@@ -76268,7 +75849,7 @@ paths:
type: User
site_admin: false
'404': *26
- '302': *522
+ '302': *519
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76284,9 +75865,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#update-a-release-asset
parameters:
- - *302
- - *303
- - *523
+ - *299
+ - *300
+ - *520
requestBody:
required: false
content:
@@ -76314,9 +75895,9 @@ paths:
description: Response
content:
application/json:
- schema: *521
+ schema: *518
examples:
- default: *524
+ default: *521
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76332,9 +75913,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#delete-a-release-asset
parameters:
- - *302
- - *303
- - *523
+ - *299
+ - *300
+ - *520
responses:
'204':
description: Response
@@ -76358,8 +75939,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -76444,16 +76025,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76470,8 +76051,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tag
description: tag parameter
in: path
@@ -76484,9 +76065,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
'404': *26
x-github:
githubCloudOnly: false
@@ -76508,9 +76089,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release
parameters:
- - *302
- - *303
- - &526
+ - *299
+ - *300
+ - &523
name: release_id
description: The unique identifier of the release.
in: path
@@ -76524,9 +76105,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
'401':
description: Unauthorized
x-github:
@@ -76544,9 +76125,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#update-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
requestBody:
required: false
content:
@@ -76603,9 +76184,9 @@ paths:
description: Response
content:
application/json:
- schema: *520
+ schema: *517
examples:
- default: *525
+ default: *522
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76621,9 +76202,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#delete-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
responses:
'204':
description: Response
@@ -76643,9 +76224,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
- *4
- *5
responses:
@@ -76655,7 +76236,7 @@ paths:
application/json:
schema:
type: array
- items: *521
+ items: *518
examples:
default:
value:
@@ -76737,9 +76318,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:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
- name: name
in: query
required: true
@@ -76765,7 +76346,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *521
+ schema: *518
examples:
response-for-successful-upload:
value:
@@ -76820,9 +76401,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -76846,9 +76427,9 @@ paths:
application/json:
schema:
type: array
- items: *404
+ items: *401
examples:
- default: *464
+ default: *461
headers:
Link: *6
'404': *26
@@ -76869,9 +76450,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *302
- - *303
- - *526
+ - *299
+ - *300
+ - *523
requestBody:
required: true
content:
@@ -76901,16 +76482,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'201':
description: Reaction created
content:
application/json:
- schema: *404
+ schema: *401
examples:
- default: *405
+ default: *402
'422': *35
x-github:
githubCloudOnly: false
@@ -76932,10 +76513,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *302
- - *303
- - *526
- - *465
+ - *299
+ - *300
+ - *523
+ - *462
responses:
'204':
description: Response
@@ -76955,8 +76536,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-cache-replication-status
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -77031,9 +76612,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *302
- - *303
- - *360
+ - *299
+ - *300
+ - *357
- *4
- *5
responses:
@@ -77050,7 +76631,7 @@ paths:
oneOf:
- allOf:
- *257
- - &527
+ - &524
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -77071,49 +76652,49 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *258
- - *527
+ - *524
- allOf:
- *259
- - *527
+ - *524
- allOf:
- *260
- - *527
+ - *524
- allOf:
- *261
- - *527
+ - *524
- allOf:
- *262
- - *527
+ - *524
- allOf:
- *263
- - *527
+ - *524
- allOf:
- *264
- - *527
+ - *524
- allOf:
- *265
- - *527
+ - *524
- allOf:
- *266
- - *527
+ - *524
- allOf:
- *267
- - *527
+ - *524
- allOf:
- *268
- - *527
+ - *524
- allOf:
- *269
- - *527
+ - *524
- allOf:
- *270
- - *527
+ - *524
- allOf:
- *271
- - *527
+ - *524
- allOf:
- *272
- - *527
+ - *524
examples:
default:
value:
@@ -77152,8 +76733,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
- name: includes_parents
@@ -77164,7 +76745,7 @@ paths:
schema:
type: boolean
default: true
- - *528
+ - *525
responses:
'200':
description: Response
@@ -77219,8 +76800,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
description: Request body
required: true
@@ -77249,7 +76830,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *529
+ items: *526
required:
- name
- enforcement
@@ -77282,7 +76863,7 @@ paths:
application/json:
schema: *273
examples:
- default: &539
+ default: &536
value:
id: 42
name: super cool ruleset
@@ -77329,12 +76910,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *302
- - *303
+ - *299
+ - *300
+ - *527
+ - *528
+ - *529
- *530
- - *531
- - *532
- - *533
- *4
- *5
responses:
@@ -77342,9 +76923,9 @@ paths:
description: Response
content:
application/json:
- schema: *534
+ schema: *531
examples:
- default: *535
+ default: *532
'404': *26
'500': *230
x-github:
@@ -77365,17 +76946,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *302
- - *303
- - *536
+ - *299
+ - *300
+ - *533
responses:
'200':
description: Response
content:
application/json:
- schema: *537
+ schema: *534
examples:
- default: *538
+ default: *535
'404': *26
'500': *230
x-github:
@@ -77403,8 +76984,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77426,7 +77007,7 @@ paths:
application/json:
schema: *273
examples:
- default: *539
+ default: *536
'404': *26
'500': *230
put:
@@ -77444,8 +77025,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77479,7 +77060,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *529
+ items: *526
examples:
default:
value:
@@ -77509,7 +77090,7 @@ paths:
application/json:
schema: *273
examples:
- default: *539
+ default: *536
'404': *26
'500': *230
delete:
@@ -77527,8 +77108,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77556,8 +77137,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *276
- *277
- *278
@@ -77565,8 +77146,8 @@ paths:
- *9
- *5
- *4
- - *540
- - *541
+ - *537
+ - *538
- *280
responses:
'200':
@@ -77575,7 +77156,7 @@ paths:
application/json:
schema:
type: array
- items: &544
+ items: &541
type: object
properties:
number: *93
@@ -77594,8 +77175,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *542
- resolution: *543
+ state: *539
+ resolution: *540
resolved_at:
type: string
format: date-time
@@ -77773,15 +77354,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
responses:
'200':
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -77821,9 +77402,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
requestBody:
required: true
content:
@@ -77831,8 +77412,8 @@ paths:
schema:
type: object
properties:
- state: *542
- resolution: *543
+ state: *539
+ resolution: *540
resolution_comment:
description: An optional comment when closing an alert. Cannot be
updated or deleted. Must be `null` when changing `state` to `open`.
@@ -77851,7 +77432,7 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -77918,9 +77499,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *302
- - *303
- - *389
+ - *299
+ - *300
+ - *386
- *5
- *4
responses:
@@ -77931,7 +77512,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &678
+ items: &673
type: object
properties:
type:
@@ -78290,8 +77871,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-stargazers
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -78387,8 +77968,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -78397,7 +77978,7 @@ paths:
application/json:
schema:
type: array
- items: &545
+ items: &542
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -78428,8 +78009,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -78502,8 +78083,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -78599,8 +78180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -78754,8 +78335,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -78765,7 +78346,7 @@ paths:
application/json:
schema:
type: array
- items: *545
+ items: *542
examples:
default:
value:
@@ -78798,8 +78379,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#create-a-commit-status
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: sha
in: path
required: true
@@ -78853,7 +78434,7 @@ paths:
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
default:
value:
@@ -78907,8 +78488,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-watchers
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -78940,14 +78521,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &547
+ schema: &544
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -79015,8 +78596,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -79042,7 +78623,7 @@ paths:
description: Response
content:
application/json:
- schema: *547
+ schema: *544
examples:
default:
value:
@@ -79069,8 +78650,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -79090,8 +78671,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -79170,8 +78751,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Response
@@ -79179,7 +78760,7 @@ paths:
application/json:
schema:
type: array
- items: &548
+ items: &545
title: Tag protection
description: Tag protection
type: object
@@ -79231,8 +78812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -79255,7 +78836,7 @@ paths:
description: Response
content:
application/json:
- schema: *548
+ schema: *545
examples:
default:
value:
@@ -79286,8 +78867,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -79324,8 +78905,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ref
in: path
required: true
@@ -79361,8 +78942,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-teams
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *4
- *5
responses:
@@ -79372,7 +78953,7 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
default: *283
headers:
@@ -79394,8 +78975,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-all-repository-topics
parameters:
- - *302
- - *303
+ - *299
+ - *300
- *5
- *4
responses:
@@ -79403,7 +78984,7 @@ paths:
description: Response
content:
application/json:
- schema: &549
+ schema: &546
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -79415,7 +78996,7 @@ paths:
required:
- names
examples:
- default: &550
+ default: &547
value:
names:
- octocat
@@ -79438,8 +79019,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -79470,9 +79051,9 @@ paths:
description: Response
content:
application/json:
- schema: *549
+ schema: *546
examples:
- default: *550
+ default: *547
'404': *26
'422': *27
x-github:
@@ -79495,8 +79076,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#transfer-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: true
content:
@@ -79770,8 +79351,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -79794,8 +79375,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -79817,8 +79398,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -79844,8 +79425,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *302
- - *303
+ - *299
+ - *300
- name: ref
in: path
required: true
@@ -79937,9 +79518,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
+ default: *312
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -80113,7 +79694,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &558
+ - &555
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -80122,7 +79703,7 @@ paths:
schema:
type: string
example: members
- - &563
+ - &560
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -80133,7 +79714,7 @@ paths:
default: 1
format: int32
example: 1
- - &564
+ - &561
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -80175,7 +79756,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &552
+ items: &549
allOf:
- type: object
required:
@@ -80250,7 +79831,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &565
+ meta: &562
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -80310,31 +79891,31 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &553
+ '400': &550
description: Bad request
content:
application/json:
- schema: *551
+ schema: *548
application/scim+json:
- schema: *551
- '401': &554
+ schema: *548
+ '401': &551
description: Authorization failure
- '403': &555
+ '403': &552
description: Permission denied
- '429': &556
+ '429': &553
description: Too many requests
content:
application/json:
- schema: *551
+ schema: *548
application/scim+json:
- schema: *551
- '500': &557
+ schema: *548
+ '500': &554
description: Internal server error
content:
application/json:
- schema: *551
+ schema: *548
application/scim+json:
- schema: *551
+ schema: *548
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80361,7 +79942,7 @@ paths:
required: true
content:
application/json:
- schema: &561
+ schema: &558
type: object
required:
- schemas
@@ -80421,9 +80002,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- group: &559
+ group: &556
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -80442,13 +80023,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *553
- '401': *554
- '403': *555
- '409': &562
+ '400': *550
+ '401': *551
+ '403': *552
+ '409': &559
description: Duplicate record detected
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80469,7 +80050,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &560
+ - &557
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -80477,22 +80058,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *558
+ - *555
- *65
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- default: *559
- '400': *553
- '401': *554
- '403': *555
+ default: *556
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80514,13 +80095,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *560
+ - *557
- *65
requestBody:
required: true
content:
application/json:
- schema: *561
+ schema: *558
examples:
group:
summary: Group
@@ -80546,17 +80127,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- group: *559
- groupWithMembers: *559
- '400': *553
- '401': *554
- '403': *555
+ group: *556
+ groupWithMembers: *556
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80580,13 +80161,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *560
+ - *557
- *65
requestBody:
required: true
content:
application/json:
- schema: &572
+ schema: &569
type: object
required:
- Operations
@@ -80646,17 +80227,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *552
+ schema: *549
examples:
- updateGroup: *559
- addMembers: *559
- '400': *553
- '401': *554
- '403': *555
+ updateGroup: *556
+ addMembers: *556
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80676,17 +80257,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *560
+ - *557
- *65
responses:
'204':
description: Group was deleted, no content
- '400': *553
- '401': *554
- '403': *555
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80723,8 +80304,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *563
- - *564
+ - *560
+ - *561
- *65
responses:
'200':
@@ -80757,7 +80338,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &567
+ items: &564
allOf:
- type: object
required:
@@ -80836,7 +80417,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &566
+ roles: &563
type: array
description: The roles assigned to the user.
items:
@@ -80892,7 +80473,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *565
+ meta: *562
startIndex:
type: integer
description: A starting index for the returned page
@@ -80929,11 +80510,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *553
- '401': *554
- '403': *555
- '429': *556
- '500': *557
+ '400': *550
+ '401': *551
+ '403': *552
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80962,7 +80543,7 @@ paths:
required: true
content:
application/json:
- schema: &570
+ schema: &567
type: object
required:
- schemas
@@ -81044,9 +80625,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *566
+ roles: *563
examples:
- user: &571
+ user: &568
summary: User
value:
schemas:
@@ -81093,9 +80674,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *567
+ schema: *564
examples:
- user: &568
+ user: &565
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -81121,13 +80702,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *568
- '400': *553
- '401': *554
- '403': *555
- '409': *562
- '429': *556
- '500': *557
+ enterpriseOwner: *565
+ '400': *550
+ '401': *551
+ '403': *552
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81148,7 +80729,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &569
+ - &566
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -81161,15 +80742,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *567
+ schema: *564
examples:
- default: *568
- '400': *553
- '401': *554
- '403': *555
+ default: *565
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81194,30 +80775,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *569
+ - *566
- *65
requestBody:
required: true
content:
application/json:
- schema: *570
+ schema: *567
examples:
- user: *571
+ user: *568
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *567
+ schema: *564
examples:
- user: *568
- '400': *553
- '401': *554
- '403': *555
+ user: *565
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81255,13 +80836,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *569
+ - *566
- *65
requestBody:
required: true
content:
application/json:
- schema: *572
+ schema: *569
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -81301,18 +80882,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *567
- examples:
- userMultiValuedProperties: *568
- userSingleValuedProperties: *568
- disableUser: *568
- '400': *553
- '401': *554
- '403': *555
+ schema: *564
+ examples:
+ userMultiValuedProperties: *565
+ userSingleValuedProperties: *565
+ disableUser: *565
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '409': *562
- '429': *556
- '500': *557
+ '409': *559
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81332,17 +80913,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *569
+ - *566
- *65
responses:
'204':
description: User was deleted, no content
- '400': *553
- '401': *554
- '403': *555
+ '400': *550
+ '401': *551
+ '403': *552
'404': *26
- '429': *556
- '500': *557
+ '429': *553
+ '500': *554
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81469,7 +81050,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &573
+ text_matches: &570
title: Search Result Text Matches
type: array
items:
@@ -81632,7 +81213,7 @@ paths:
enum:
- author-date
- committer-date
- - &574
+ - &571
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
@@ -81703,7 +81284,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *358
+ properties: *355
nullable: true
comment_count:
type: integer
@@ -81723,7 +81304,7 @@ paths:
url:
type: string
format: uri
- verification: *453
+ verification: *450
required:
- author
- committer
@@ -81742,7 +81323,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *358
+ properties: *355
nullable: true
parents:
type: array
@@ -81760,7 +81341,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *573
+ text_matches: *570
required:
- sha
- node_id
@@ -81953,7 +81534,7 @@ paths:
- interactions
- created
- updated
- - *574
+ - *571
- *4
- *5
- name: advanced_search
@@ -82050,11 +81631,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
type: string
state_reason:
@@ -82086,7 +81667,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *573
+ text_matches: *570
pull_request:
type: object
properties:
@@ -82130,7 +81711,7 @@ paths:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
performed_via_github_app:
title: GitHub app
description: GitHub apps are a new way to extend GitHub.
@@ -82311,7 +81892,7 @@ paths:
enum:
- created
- updated
- - *574
+ - *571
- *4
- *5
responses:
@@ -82355,7 +81936,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *573
+ text_matches: *570
required:
- id
- node_id
@@ -82441,7 +82022,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *574
+ - *571
- *4
- *5
responses:
@@ -82680,7 +82261,7 @@ paths:
- admin
- pull
- push
- text_matches: *573
+ text_matches: *570
temp_clone_token:
type: string
allow_merge_commit:
@@ -82981,7 +82562,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *573
+ text_matches: *570
related:
type: array
nullable: true
@@ -83174,7 +82755,7 @@ paths:
- followers
- repositories
- joined
- - *574
+ - *571
- *4
- *5
responses:
@@ -83278,7 +82859,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *573
+ text_matches: *570
blog:
type: string
nullable: true
@@ -83473,7 +83054,7 @@ paths:
description: Response
content:
application/json:
- schema: &579
+ schema: &576
type: object
properties:
status:
@@ -83493,7 +83074,7 @@ paths:
- name
- number
examples:
- default: &580
+ default: &577
value:
status: scheduled
scheduled_time: Tuesday, January 22 at 15:34 -0800
@@ -83538,9 +83119,9 @@ paths:
description: Response
content:
application/json:
- schema: *579
+ schema: *576
examples:
- default: *580
+ default: *577
'401':
description: Unauthorized
requestBody:
@@ -84104,7 +83685,7 @@ paths:
application/json:
schema:
type: array
- items: &581
+ items: &578
type: object
properties:
key:
@@ -84112,7 +83693,7 @@ paths:
pretty-print:
type: string
examples:
- default: &582
+ default: &579
value:
- key: ssh-rsa AAAAB3NzaC1yc2EAAAAB...
pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64
@@ -84155,9 +83736,9 @@ paths:
application/json:
schema:
type: array
- items: *581
+ items: *578
examples:
- default: *582
+ default: *579
'401':
description: Unauthorized
requestBody:
@@ -84209,9 +83790,9 @@ paths:
application/json:
schema:
type: array
- items: *581
+ items: *578
examples:
- default: *582
+ default: *579
'401':
description: Unauthorized
requestBody:
@@ -84541,7 +84122,7 @@ paths:
type: array
items: *289
examples:
- default: *583
+ default: *580
headers:
Link: *6
x-github:
@@ -84693,7 +84274,7 @@ paths:
application/json:
schema: *289
examples:
- default: *584
+ default: *581
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84731,218 +84312,6 @@ paths:
category: teams
subcategory: discussions
deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments":
- get:
- summary: List discussion comments (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint.
-
- List all comments on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussion-comments-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy
- parameters:
- - *7
- - *291
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *292
- examples:
- default: *585
- headers:
- Link: *6
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- post:
- summary: Create a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.
-
- Creates a new comment on a team discussion.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like apples?
- responses:
- '201':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *293
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}":
- get:
- summary: Get a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.
-
- Get a specific comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- - *294
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *293
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- patch:
- summary: Update a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
-
- Edits the body text of a discussion comment.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- - *294
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: object
- properties:
- body:
- type: string
- description: The discussion comment's body text.
- required:
- - body
- examples:
- default:
- value:
- body: Do you like pineapples?
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *292
- examples:
- default: *586
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
- delete:
- summary: Delete a discussion comment (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.
-
- Deletes a comment on a team discussion.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-comment-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment-legacy
- parameters:
- - *7
- - *291
- - *294
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussion-comments
- deprecated: true
"/teams/{team_id}/members":
get:
summary: List team members (Legacy)
@@ -85130,9 +84499,9 @@ paths:
description: Response
content:
application/json:
- schema: *299
+ schema: *296
examples:
- response-if-user-is-a-team-maintainer: *587
+ response-if-user-is-a-team-maintainer: *582
'404': *26
x-github:
githubCloudOnly: false
@@ -85191,9 +84560,9 @@ paths:
description: Response
content:
application/json:
- schema: *299
+ schema: *296
examples:
- response-if-users-membership-with-team-is-now-pending: *588
+ response-if-users-membership-with-team-is-now-pending: *583
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -85266,9 +84635,9 @@ paths:
application/json:
schema:
type: array
- items: *300
+ items: *297
examples:
- default: *589
+ default: *584
headers:
Link: *6
'404': *26
@@ -85295,15 +84664,15 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project-legacy
parameters:
- *7
- - *301
+ - *298
responses:
'200':
description: Response
content:
application/json:
- schema: *300
+ schema: *297
examples:
- default: *590
+ default: *585
'404':
description: Not Found if project is not managed by this team
x-github:
@@ -85328,7 +84697,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- *7
- - *301
+ - *298
requestBody:
required: false
content:
@@ -85397,7 +84766,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team-legacy
parameters:
- *7
- - *301
+ - *298
responses:
'204':
description: Response
@@ -85467,14 +84836,14 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- *7
- - *302
- - *303
+ - *299
+ - *300
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *591
+ schema: *586
examples:
alternative-response-with-extra-repository-information:
value:
@@ -85626,8 +84995,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- *7
- - *302
- - *303
+ - *299
+ - *300
requestBody:
required: false
content:
@@ -85678,8 +85047,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- *7
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -85714,9 +85083,9 @@ paths:
application/json:
schema:
type: array
- items: *304
+ items: *301
examples:
- response-if-child-teams-exist: *592
+ response-if-child-teams-exist: *587
headers:
Link: *6
'404': *26
@@ -85749,7 +85118,7 @@ paths:
application/json:
schema:
oneOf:
- - &594
+ - &589
title: Private User
description: Private User
type: object
@@ -85952,7 +85321,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *593
+ - *588
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -86103,7 +85472,7 @@ paths:
description: Response
content:
application/json:
- schema: *594
+ schema: *589
examples:
default:
value:
@@ -86181,7 +85550,7 @@ paths:
type: array
items: *224
examples:
- default: &604
+ default: &599
value:
- id: 197
name: hello_docker
@@ -86268,7 +85637,7 @@ paths:
application/json:
schema:
type: array
- items: &595
+ items: &590
title: Email
description: Email
type: object
@@ -86293,7 +85662,7 @@ paths:
- verified
- visibility
examples:
- default: &606
+ default: &601
value:
- email: octocat@github.com
verified: true
@@ -86368,7 +85737,7 @@ paths:
application/json:
schema:
type: array
- items: *595
+ items: *590
examples:
default:
value:
@@ -86624,7 +85993,7 @@ paths:
application/json:
schema:
type: array
- items: &596
+ items: &591
title: GPG Key
description: A unique encryption key
type: object
@@ -86755,7 +86124,7 @@ paths:
- subkeys
- revoked
examples:
- default: &616
+ default: &611
value:
- id: 3
name: Octocat's GPG Key
@@ -86840,9 +86209,9 @@ paths:
description: Response
content:
application/json:
- schema: *596
+ schema: *591
examples:
- default: &597
+ default: &592
value:
id: 3
name: Octocat's GPG Key
@@ -86899,7 +86268,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &598
+ - &593
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -86911,9 +86280,9 @@ paths:
description: Response
content:
application/json:
- schema: *596
+ schema: *591
examples:
- default: *597
+ default: *592
'404': *26
'304': *42
'403': *43
@@ -86936,7 +86305,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *598
+ - *593
responses:
'204':
description: Response
@@ -87127,7 +86496,7 @@ paths:
type: array
items: *84
examples:
- default: *599
+ default: *594
headers:
Link: *6
'404': *26
@@ -87303,7 +86672,7 @@ paths:
application/json:
schema:
type: array
- items: &600
+ items: &595
title: Key
description: Key
type: object
@@ -87404,9 +86773,9 @@ paths:
description: Response
content:
application/json:
- schema: *600
+ schema: *595
examples:
- default: &601
+ default: &596
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -87439,15 +86808,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *488
+ - *485
responses:
'200':
description: Response
content:
application/json:
- schema: *600
+ schema: *595
examples:
- default: *601
+ default: *596
'404': *26
'304': *42
'403': *43
@@ -87470,7 +86839,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *488
+ - *485
responses:
'204':
description: Response
@@ -88290,7 +87659,7 @@ paths:
type: array
items: *70
examples:
- default: *602
+ default: *597
headers:
Link: *6
'304': *42
@@ -88332,7 +87701,7 @@ paths:
- docker
- nuget
- container
- - *603
+ - *598
- *5
- *4
responses:
@@ -88344,8 +87713,8 @@ paths:
type: array
items: *224
examples:
- default: *604
- '400': *605
+ default: *599
+ '400': *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -88374,7 +87743,7 @@ paths:
application/json:
schema: *224
examples:
- default: &617
+ default: &612
value:
id: 40201
name: octo-name
@@ -88825,9 +88194,9 @@ paths:
application/json:
schema:
type: array
- items: *595
+ items: *590
examples:
- default: *606
+ default: *601
headers:
Link: *6
'304': *42
@@ -88940,7 +88309,7 @@ paths:
type: array
items: *84
examples:
- default: &613
+ default: &608
summary: Default response
value:
- id: 1296269
@@ -89244,9 +88613,9 @@ paths:
description: Response
content:
application/json:
- schema: *313
+ schema: *310
examples:
- default: *315
+ default: *312
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -89284,9 +88653,9 @@ paths:
application/json:
schema:
type: array
- items: *460
+ items: *457
examples:
- default: *607
+ default: *602
headers:
Link: *6
'304': *42
@@ -89309,7 +88678,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#accept-a-repository-invitation
parameters:
- - *461
+ - *458
responses:
'204':
description: Response
@@ -89332,7 +88701,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#decline-a-repository-invitation
parameters:
- - *461
+ - *458
responses:
'204':
description: Response
@@ -89365,7 +88734,7 @@ paths:
application/json:
schema:
type: array
- items: &608
+ items: &603
title: Social account
description: Social media account
type: object
@@ -89380,7 +88749,7 @@ paths:
- provider
- url
examples:
- default: &609
+ default: &604
value:
- provider: twitter
url: https://twitter.com/github
@@ -89442,9 +88811,9 @@ paths:
application/json:
schema:
type: array
- items: *608
+ items: *603
examples:
- default: *609
+ default: *604
'422': *35
'304': *42
'404': *26
@@ -89531,7 +88900,7 @@ paths:
application/json:
schema:
type: array
- items: &610
+ items: &605
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -89551,7 +88920,7 @@ paths:
- title
- created_at
examples:
- default: &618
+ default: &613
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -89615,9 +88984,9 @@ paths:
description: Response
content:
application/json:
- schema: *610
+ schema: *605
examples:
- default: &611
+ default: &606
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -89647,7 +89016,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &612
+ - &607
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -89659,9 +89028,9 @@ paths:
description: Response
content:
application/json:
- schema: *610
+ schema: *605
examples:
- default: *611
+ default: *606
'404': *26
'304': *42
'403': *43
@@ -89684,7 +89053,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *612
+ - *607
responses:
'204':
description: Response
@@ -89713,7 +89082,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &619
+ - &614
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
@@ -89738,11 +89107,11 @@ paths:
type: array
items: *84
examples:
- default-response: *613
+ default-response: *608
application/vnd.github.v3.star+json:
schema:
type: array
- items: &620
+ items: &615
title: Starred Repository
description: Starred Repository
type: object
@@ -89898,8 +89267,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response if this repository is starred by you
@@ -89927,8 +89296,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -89952,8 +89321,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *302
- - *303
+ - *299
+ - *300
responses:
'204':
description: Response
@@ -90112,10 +89481,10 @@ paths:
application/json:
schema:
oneOf:
- - *594
- - *593
+ - *589
+ - *588
examples:
- default-response: &614
+ default-response: &609
summary: Default response
value:
login: octocat
@@ -90150,7 +89519,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &615
+ response-with-git-hub-plan-information: &610
summary: Response with GitHub plan information
value:
login: octocat
@@ -90262,11 +89631,11 @@ paths:
application/json:
schema:
oneOf:
- - *594
- - *593
+ - *589
+ - *588
examples:
- default-response: *614
- response-with-git-hub-plan-information: *615
+ default-response: *609
+ response-with-git-hub-plan-information: *610
'404': *26
x-github:
githubCloudOnly: false
@@ -90297,7 +89666,7 @@ paths:
type: array
items: *224
examples:
- default: *604
+ default: *599
'403': *43
'401': *41
x-github:
@@ -90710,9 +90079,9 @@ paths:
application/json:
schema:
type: array
- items: *596
+ items: *591
examples:
- default: *616
+ default: *611
headers:
Link: *6
x-github:
@@ -90816,7 +90185,7 @@ paths:
application/json:
schema: *39
examples:
- default: *459
+ default: *456
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90901,7 +90270,7 @@ paths:
type: array
items: *70
examples:
- default: *602
+ default: *597
headers:
Link: *6
x-github:
@@ -90940,7 +90309,7 @@ paths:
- docker
- nuget
- container
- - *603
+ - *598
- *8
- *5
- *4
@@ -90953,10 +90322,10 @@ paths:
type: array
items: *224
examples:
- default: *604
+ default: *599
'403': *43
'401': *41
- '400': *605
+ '400': *600
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90986,7 +90355,7 @@ paths:
application/json:
schema: *224
examples:
- default: *617
+ default: *612
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -91615,9 +90984,9 @@ paths:
application/json:
schema:
type: array
- items: *608
+ items: *603
examples:
- default: *609
+ default: *604
headers:
Link: *6
x-github:
@@ -91647,9 +91016,9 @@ paths:
application/json:
schema:
type: array
- items: *610
+ items: *605
examples:
- default: *618
+ default: *613
headers:
Link: *6
x-github:
@@ -91674,7 +91043,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *8
- - *619
+ - *614
- *9
- *4
- *5
@@ -91686,11 +91055,11 @@ paths:
schema:
anyOf:
- type: array
- items: *620
+ items: *615
- type: array
items: *84
examples:
- default-response: *613
+ default-response: *608
headers:
Link: *6
x-github:
@@ -91900,7 +91269,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &621
+ enterprise: &616
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -91958,7 +91327,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &622
+ installation: &617
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -91977,7 +91346,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &623
+ organization: &618
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -92037,13 +91406,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &624
+ repository: &619
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: &652
+ properties: &647
id:
description: Unique identifier of the repository
example: 42
@@ -92726,7 +92095,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &653
+ required: &648
- archive_url
- assignees_url
- blobs_url
@@ -92877,10 +92246,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -92966,11 +92335,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- rule: &625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ rule: &620
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -93187,11 +92556,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- rule: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ rule: *620
sender: *19
required:
- action
@@ -93365,11 +92734,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- rule: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ rule: *620
sender: *19
required:
- action
@@ -93450,11 +92819,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: &626
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: &621
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -93723,7 +93092,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &627
+ items: &622
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -93841,11 +93210,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
sender: *19
required:
- action
@@ -93925,11 +93294,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
sender: *19
required:
- action
@@ -94009,12 +93378,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
- exemption_response: *627
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
+ exemption_response: *622
sender: *19
required:
- action
@@ -94096,12 +93465,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- exemption_request: *626
- exemption_response: *627
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ exemption_request: *621
+ exemption_response: *622
sender: *19
required:
- action
@@ -94186,12 +93555,12 @@ x-webhooks:
type: string
cache_location:
type: string
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
ref:
type: string
- repository: *624
+ repository: *619
sender: *19
required:
- cache_location
@@ -94285,7 +93654,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &629
+ check_run: &624
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -94338,7 +93707,7 @@ x-webhooks:
type: string
pull_requests:
type: array
- items: *371
+ items: *368
repository: *158
status:
example: completed
@@ -94376,7 +93745,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *628
+ deployment: *623
details_url:
example: https://example.com
type: string
@@ -94426,7 +93795,7 @@ x-webhooks:
- annotations_url
pull_requests:
type: array
- items: *371
+ items: *368
started_at:
example: '2018-05-04T01:14:52Z'
type: string
@@ -94461,10 +93830,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
sender: *19
required:
- check_run
@@ -94867,11 +94236,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *629
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ check_run: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
sender: *19
required:
- check_run
@@ -95277,11 +94646,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *629
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ check_run: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
requested_action:
description: The action requested by the user.
type: object
@@ -95696,11 +95065,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *629
- installation: *622
- enterprise: *621
- organization: *623
- repository: *624
+ check_run: *624
+ installation: *617
+ enterprise: *616
+ organization: *618
+ repository: *619
sender: *19
required:
- check_run
@@ -96687,10 +96056,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -97394,10 +96763,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -98095,10 +97464,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -98274,7 +97643,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -98419,20 +97788,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &630
+ commit_oid: &625
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: *621
- installation: *622
- organization: *623
- ref: &631
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: &626
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: *624
+ repository: *619
sender: *19
required:
- action
@@ -98607,7 +97976,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -98837,12 +98206,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -98947,7 +98316,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -99118,12 +98487,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -99299,7 +98668,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -99465,12 +98834,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -99579,7 +98948,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -99754,16 +99123,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
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: *624
+ repository: *619
sender: *19
required:
- action
@@ -99870,7 +99239,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *384
+ dismissed_comment: *381
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -100010,12 +99379,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *630
- enterprise: *621
- installation: *622
- organization: *623
- ref: *631
- repository: *624
+ commit_oid: *625
+ enterprise: *616
+ installation: *617
+ organization: *618
+ ref: *626
+ repository: *619
sender: *19
required:
- action
@@ -100282,10 +99651,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -100375,18 +99744,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *623
- pusher_type: &632
+ organization: *618
+ pusher_type: &627
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &633
+ ref: &628
description: The [`git ref`](https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference)
resource.
type: string
@@ -100396,7 +99765,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *624
+ repository: *619
sender: *19
required:
- ref
@@ -100479,9 +99848,9 @@ x-webhooks:
enum:
- created
definition: *244
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
sender: *19
required:
- action
@@ -100566,9 +99935,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
sender: *19
required:
- action
@@ -100646,9 +100015,9 @@ x-webhooks:
enum:
- updated
definition: *244
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
sender: *19
required:
- action
@@ -100725,10 +100094,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- repository: *624
- organization: *623
+ enterprise: *616
+ installation: *617
+ repository: *619
+ organization: *618
sender: *19
new_property_values:
type: array
@@ -100823,18 +100192,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
- pusher_type: *632
- ref: *633
+ enterprise: *616
+ installation: *617
+ organization: *618
+ pusher_type: *627
+ ref: *628
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *624
+ repository: *619
sender: *19
required:
- ref
@@ -100928,11 +100297,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101026,11 +100395,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101124,11 +100493,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101220,11 +100589,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101316,11 +100685,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101413,11 +100782,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101509,11 +100878,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *422
- installation: *622
- organization: *623
- enterprise: *621
- repository: *624
+ alert: *419
+ installation: *617
+ organization: *618
+ enterprise: *616
+ repository: *619
sender: *19
required:
- action
@@ -101600,9 +100969,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- key: &634
+ enterprise: *616
+ installation: *617
+ key: &629
description: The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -101636,8 +101005,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -101724,11 +101093,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- key: *634
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ key: *629
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -102299,12 +101668,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: &638
+ workflow: &633
title: Workflow
type: object
nullable: true
@@ -103040,13 +102409,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *428
+ deployment: *425
pull_requests:
type: array
items: *117
- repository: *624
- organization: *623
- installation: *622
+ repository: *619
+ organization: *618
+ installation: *617
sender: *19
responses:
'200':
@@ -103127,7 +102496,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &635
+ approver: &630
type: object
properties:
avatar_url:
@@ -103170,11 +102539,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- reviewers: &636
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ reviewers: &631
type: array
items:
type: object
@@ -103253,7 +102622,7 @@ x-webhooks:
sender: *19
since:
type: string
- workflow_job_run: &637
+ workflow_job_run: &632
type: object
properties:
conclusion:
@@ -103994,18 +103363,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *635
+ approver: *630
comment:
type: string
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- reviewers: *636
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ reviewers: *631
sender: *19
since:
type: string
- workflow_job_run: *637
+ workflow_job_run: *632
workflow_job_runs:
type: array
items:
@@ -104719,13 +104088,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *621
+ enterprise: *616
environment:
type: string
- installation: *622
- organization: *623
- repository: *624
- requestor: &643
+ installation: *617
+ organization: *618
+ repository: *619
+ requestor: &638
title: User
type: object
nullable: true
@@ -106634,12 +106003,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Deployment Workflow Run
type: object
@@ -107329,7 +106698,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &641
+ answer: &636
type: object
properties:
author_association:
@@ -107486,7 +106855,7 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: &639
+ discussion: &634
title: Discussion
description: A Discussion in a repository.
type: object
@@ -107793,10 +107162,10 @@ x-webhooks:
- updated_at
- active_lock_reason
- body
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -107933,11 +107302,11 @@ x-webhooks:
- from
required:
- category
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108030,11 +107399,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108126,7 +107495,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &640
+ comment: &635
type: object
properties:
author_association:
@@ -108283,11 +107652,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108380,12 +107749,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *640
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ comment: *635
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108490,12 +107859,12 @@ x-webhooks:
- from
required:
- body
- comment: *640
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ comment: *635
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108589,11 +107958,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108685,11 +108054,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108799,11 +108168,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -108895,10 +108264,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *639
- enterprise: *621
- installation: *622
- label: &642
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ label: &637
title: Label
type: object
properties:
@@ -108930,8 +108299,8 @@ x-webhooks:
- color
- default
- description
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109024,11 +108393,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109120,11 +108489,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109216,11 +108585,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109315,16 +108684,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *639
- new_repository: *624
+ new_discussion: *634
+ new_repository: *619
required:
- new_discussion
- new_repository
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109417,10 +108786,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *639
- old_answer: *641
- organization: *623
- repository: *624
+ discussion: *634
+ old_answer: *636
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109512,12 +108881,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *639
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109610,11 +108979,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109706,11 +109075,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *639
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ discussion: *634
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -109951,7 +109320,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *621
+ enterprise: *616
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository)
resource.
@@ -110611,9 +109980,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *622
- organization: *623
- repository: *624
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- forkee
@@ -110779,9 +110148,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pages:
description: The pages that were updated.
type: array
@@ -110818,7 +110187,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *624
+ repository: *619
sender: *19
required:
- pages
@@ -110904,10 +110273,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: &644
+ organization: *618
+ repositories: &639
description: An array of repository objects that the installation
can access.
type: array
@@ -110933,8 +110302,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *624
- requester: *643
+ repository: *619
+ requester: *638
sender: *19
required:
- action
@@ -111019,11 +110388,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -111109,11 +110478,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -111199,10 +110568,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories_added: &645
+ organization: *618
+ repositories_added: &640
description: An array of repository objects, which were added to
the installation.
type: array
@@ -111248,15 +110617,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *624
- repository_selection: &646
+ repository: *619
+ repository_selection: &641
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *643
+ requester: *638
sender: *19
required:
- action
@@ -111345,10 +110714,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories_added: *645
+ organization: *618
+ repositories_added: *640
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -111375,9 +110744,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *624
- repository_selection: *646
- requester: *643
+ repository: *619
+ repository_selection: *641
+ requester: *638
sender: *19
required:
- action
@@ -111466,11 +110835,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -111659,10 +111028,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
target_type:
type: string
@@ -111751,11 +111120,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *621
+ enterprise: *616
installation: *39
- organization: *623
- repositories: *644
- repository: *624
+ organization: *618
+ repositories: *639
+ repository: *619
requester:
nullable: true
sender: *19
@@ -112017,8 +111386,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -112812,8 +112181,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -112829,7 +112198,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -113162,8 +112531,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -113253,7 +112622,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &647
+ comment: &642
title: issue comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment)
itself.
@@ -113418,8 +112787,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -114209,8 +113578,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -114226,7 +113595,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -114561,8 +113930,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -114652,7 +114021,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &670
+ changes: &665
description: The changes to the comment.
type: object
properties:
@@ -114664,9 +114033,9 @@ x-webhooks:
type: string
required:
- from
- comment: *647
- enterprise: *621
- installation: *622
+ comment: *642
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -115459,8 +114828,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -115476,7 +114845,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -115809,8 +115178,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -115902,10 +115271,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *643
- enterprise: *621
- installation: *622
- issue: &650
+ assignee: *638
+ enterprise: *616
+ installation: *617
+ issue: &645
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -116694,11 +116063,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -116714,7 +116083,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -116815,8 +116184,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -116906,8 +116275,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -117701,11 +117070,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -117721,7 +117090,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -117957,8 +117326,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -118047,8 +117416,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -118833,11 +118202,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -118853,7 +118222,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -118953,8 +118322,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -119043,8 +118412,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -119851,11 +119220,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -119871,7 +119240,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -119950,7 +119319,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &648
+ milestone: &643
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -120088,8 +119457,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -120198,8 +119567,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -120988,11 +120357,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -121005,7 +120374,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
title:
description: Title of the issue
type: string
@@ -121109,9 +120478,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *642
- organization: *623
- repository: *624
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -121201,8 +120570,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -121990,11 +121359,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -122007,7 +121376,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
title:
description: Title of the issue
type: string
@@ -122111,9 +121480,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *642
- organization: *623
- repository: *624
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -122203,8 +121572,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -123016,11 +122385,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -123033,7 +122402,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *578
+ type: *575
title:
description: Title of the issue
type: string
@@ -123114,8 +122483,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -123204,8 +122573,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -124011,11 +123380,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -124031,7 +123400,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -124109,9 +123478,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *648
- organization: *623
- repository: *624
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -124989,11 +124358,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -125086,7 +124455,7 @@ x-webhooks:
required:
- login
- id
- type: *578
+ type: *575
required:
- id
- number
@@ -125555,8 +124924,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -126345,11 +125714,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126365,7 +125734,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -126465,8 +125834,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -126556,9 +125925,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *621
- installation: *622
- issue: &649
+ enterprise: *616
+ installation: *617
+ issue: &644
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -127341,11 +126710,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -127361,7 +126730,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -127461,8 +126830,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -127551,8 +126920,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -128362,11 +127731,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128460,9 +127829,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- type: *578
- organization: *623
- repository: *624
+ type: *575
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -129338,11 +128707,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -129358,7 +128727,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -129926,11 +129295,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *621
- installation: *622
- issue: *649
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *644
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -130021,7 +129390,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &673
+ assignee: &668
title: User
type: object
nullable: true
@@ -130091,11 +129460,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *621
- installation: *622
- issue: *650
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *645
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -130184,12 +129553,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *621
- installation: *622
- issue: *650
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *645
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -130279,8 +129648,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -131090,11 +130459,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *575
- issue_dependencies_summary: *576
+ sub_issues_summary: *572
+ issue_dependencies_summary: *573
issue_field_values:
type: array
- items: *577
+ items: *574
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131110,7 +130479,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *578
+ type: *575
updated_at:
type: string
format: date-time
@@ -131188,8 +130557,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131279,11 +130648,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *621
- installation: *622
- issue: *649
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ issue: *644
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131372,11 +130741,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131464,11 +130833,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131588,11 +130957,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- label: *642
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ label: *637
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131706,11 +131075,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131820,11 +131189,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -131913,11 +131282,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -132005,11 +131374,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -132085,7 +131454,7 @@ x-webhooks:
required:
- login
- id
- team: &651
+ team: &646
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -132318,11 +131687,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *621
- installation: *622
- member: *643
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ member: *638
+ organization: *618
+ repository: *619
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -132399,7 +131768,7 @@ x-webhooks:
required:
- login
- id
- team: *651
+ team: *646
required:
- action
- scope
@@ -132487,7 +131856,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
+ enterprise: *616
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -132596,16 +131965,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *622
- organization: *623
+ installation: *617
+ organization: *618
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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -132696,11 +132065,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
- milestone: *648
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -132789,9 +132158,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- milestone: &654
+ enterprise: *616
+ installation: *617
+ milestone: &649
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -132928,8 +132297,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133018,11 +132387,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- milestone: *648
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133142,11 +132511,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- milestone: *648
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *643
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133236,11 +132605,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *621
- installation: *622
- milestone: *654
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ milestone: *649
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133329,9 +132698,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- membership: &655
+ enterprise: *616
+ installation: *617
+ membership: &650
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -133438,8 +132807,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133527,11 +132896,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *621
- installation: *622
- membership: *655
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ membership: *650
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133620,8 +132989,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -133737,10 +133106,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
- user: *643
+ user: *638
required:
- action
- invitation
@@ -133828,11 +133197,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *621
- installation: *622
- membership: *655
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ membership: *650
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -133929,11 +133298,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *621
- installation: *622
- membership: *655
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ membership: *650
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -134019,9 +133388,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
package:
description: Information about the package.
type: object
@@ -134520,7 +133889,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &656
+ items: &651
title: Ruby Gems metadata
type: object
properties:
@@ -134615,7 +133984,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -134701,9 +134070,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
package:
description: Information about the package.
type: object
@@ -135056,7 +134425,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *656
+ items: *651
source_url:
type: string
format: uri
@@ -135126,7 +134495,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -135313,12 +134682,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *621
+ enterprise: *616
id:
type: integer
- installation: *622
- organization: *623
- repository: *624
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- id
@@ -135395,7 +134764,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &657
+ personal_access_token_request: &652
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -135541,10 +134910,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *621
- organization: *623
+ enterprise: *616
+ organization: *618
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135621,11 +134990,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *657
- enterprise: *621
- organization: *623
+ personal_access_token_request: *652
+ enterprise: *616
+ organization: *618
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135701,11 +135070,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *657
- enterprise: *621
- organization: *623
+ personal_access_token_request: *652
+ enterprise: *616
+ organization: *618
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135780,11 +135149,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *657
- organization: *623
- enterprise: *621
+ personal_access_token_request: *652
+ organization: *618
+ enterprise: *616
sender: *19
- installation: *622
+ installation: *617
required:
- action
- personal_access_token_request
@@ -135899,7 +135268,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *658
+ last_response: *653
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -135931,8 +135300,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
zen:
description: Random string of GitHub zen.
@@ -136187,10 +135556,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *621
- installation: *622
- organization: *623
- project_card: &659
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_card: &654
title: Project Card
type: object
properties:
@@ -136309,7 +135678,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -136400,11 +135769,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- project_card: *659
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_card: *654
+ repository: *619
sender: *19
required:
- action
@@ -136494,9 +135863,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
project_card:
title: Project Card
type: object
@@ -136624,8 +135993,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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -136729,11 +136098,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *621
- installation: *622
- organization: *623
- project_card: *659
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_card: *654
+ repository: *619
sender: *19
required:
- action
@@ -136837,9 +136206,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
project_card:
allOf:
- title: Project Card
@@ -137029,7 +136398,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -137119,10 +136488,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
- organization: *623
- project: &661
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: &656
title: Project
type: object
properties:
@@ -137246,7 +136615,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -137336,10 +136705,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- project_column: &660
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: &655
title: Project Column
type: object
properties:
@@ -137378,7 +136747,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -137467,18 +136836,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- project_column: *660
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: *655
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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -137578,11 +136947,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- project_column: *660
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: *655
+ repository: *619
sender: *19
required:
- action
@@ -137672,11 +137041,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *621
- installation: *622
- organization: *623
- project_column: *660
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project_column: *655
+ repository: *619
sender: *19
required:
- action
@@ -137766,11 +137135,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
+ repository: *619
sender: *19
required:
- action
@@ -137860,18 +137229,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
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: *652
- required: *653
+ properties: *647
+ required: *648
nullable: true
sender: *19
required:
@@ -137983,11 +137352,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
+ repository: *619
sender: *19
required:
- action
@@ -138076,11 +137445,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *621
- installation: *622
- organization: *623
- project: *661
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ project: *656
+ repository: *619
sender: *19
required:
- action
@@ -138171,9 +137540,9 @@ x-webhooks:
type: string
enum:
- closed
- installation: *622
- organization: *623
- projects_v2: &662
+ installation: *617
+ organization: *618
+ projects_v2: &657
title: Projects v2 Project
description: A projects v2 project
type: object
@@ -138405,9 +137774,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -138498,9 +137867,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -138627,9 +137996,9 @@ x-webhooks:
type: string
to:
type: string
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -138722,7 +138091,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &666
+ changes: &661
type: object
properties:
archived_at:
@@ -138736,9 +138105,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *622
- organization: *623
- projects_v2_item: &663
+ installation: *617
+ organization: *618
+ projects_v2_item: &658
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -138890,9 +138259,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -138984,9 +138353,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139077,9 +138446,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139195,7 +138564,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &664
+ - &659
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -139217,7 +138586,7 @@ x-webhooks:
required:
- id
- name
- - &665
+ - &660
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -139251,8 +138620,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *664
- - *665
+ - *659
+ - *660
required:
- field_value
- type: object
@@ -139268,9 +138637,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139375,9 +138744,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *622
- organization: *623
- projects_v2_item: *663
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139470,10 +138839,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *666
- installation: *622
- organization: *623
- projects_v2_item: *663
+ changes: *661
+ installation: *617
+ organization: *618
+ projects_v2_item: *658
sender: *19
required:
- action
@@ -139565,9 +138934,9 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *622
- organization: *623
- projects_v2: *662
+ installation: *617
+ organization: *618
+ projects_v2: *657
sender: *19
required:
- action
@@ -139648,10 +139017,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- repository
@@ -139738,13 +139107,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *643
- enterprise: *621
- installation: *622
- number: &667
+ assignee: *638
+ enterprise: *616
+ installation: *617
+ number: &662
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -142027,7 +141396,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -142119,11 +141488,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -144401,7 +143770,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -144493,11 +143862,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -146775,7 +146144,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -146867,11 +146236,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: &668
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: &663
allOf:
- *117
- type: object
@@ -146935,7 +146304,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -147026,12 +146395,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -147121,11 +146490,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *621
- milestone: *491
- number: *667
- organization: *623
- pull_request: &669
+ enterprise: *616
+ milestone: *488
+ number: *662
+ organization: *618
+ pull_request: &664
title: Pull Request
type: object
properties:
@@ -149388,7 +148757,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -149520,12 +148889,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -149615,11 +148984,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *621
- installation: *622
- label: *642
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ label: *637
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -151901,7 +151270,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -151992,10 +151361,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -154275,7 +153644,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -154365,12 +153734,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *621
- milestone: *491
- number: *667
- organization: *623
- pull_request: *669
- repository: *624
+ enterprise: *616
+ milestone: *488
+ number: *662
+ organization: *618
+ pull_request: *664
+ repository: *619
sender: *19
required:
- action
@@ -154459,12 +153828,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -154555,12 +153924,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -154650,12 +154019,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
- pull_request: *668
- repository: *624
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
+ pull_request: *663
+ repository: *619
sender: *19
required:
- action
@@ -155031,9 +154400,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
type: object
properties:
@@ -157203,7 +156572,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -157293,7 +156662,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &671
+ comment: &666
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -157578,9 +156947,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
type: object
properties:
@@ -159738,7 +159107,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -159828,11 +159197,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *670
- comment: *671
- enterprise: *621
- installation: *622
- organization: *623
+ changes: *665
+ comment: *666
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
type: object
properties:
@@ -161993,7 +161362,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -162084,9 +161453,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -164259,7 +163628,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
+ repository: *619
review:
description: The review that was affected.
type: object
@@ -164516,9 +163885,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -166572,8 +165941,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
- review: &672
+ repository: *619
+ review: &667
description: The review that was affected.
type: object
properties:
@@ -166816,12 +166185,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -169104,7 +168473,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_reviewer:
title: User
type: object
@@ -169188,12 +168557,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -171483,7 +170852,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -171685,12 +171054,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -173975,7 +173344,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_reviewer:
title: User
type: object
@@ -174060,12 +173429,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *621
- installation: *622
+ enterprise: *616
+ installation: *617
number:
description: The pull request number.
type: integer
- organization: *623
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -176341,7 +175710,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -176532,9 +175901,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -178709,8 +178078,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
- review: *672
+ repository: *619
+ review: *667
sender: *19
required:
- action
@@ -178800,9 +178169,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -180872,7 +180241,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
thread:
type: object
@@ -181269,9 +180638,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
pull_request:
title: Simple Pull Request
type: object
@@ -183327,7 +182696,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *624
+ repository: *619
sender: *19
thread:
type: object
@@ -183727,10 +183096,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -186001,7 +185370,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -186093,11 +185462,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *673
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ assignee: *668
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -188380,7 +187749,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -188469,11 +187838,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *621
- installation: *622
- label: *642
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ label: *637
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -190746,7 +190115,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -190837,10 +190206,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *621
- installation: *622
- number: *667
- organization: *623
+ enterprise: *616
+ installation: *617
+ number: *662
+ organization: *618
pull_request:
title: Pull Request
type: object
@@ -193105,7 +192474,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -193315,7 +192684,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *621
+ enterprise: *616
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -193407,8 +192776,8 @@ x-webhooks:
- url
- author
- committer
- installation: *622
- organization: *623
+ installation: *617
+ organization: *618
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -193993,9 +193362,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
registry_package:
type: object
properties:
@@ -194441,7 +193810,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *656
+ items: *651
summary:
type: string
tag_name:
@@ -194495,7 +193864,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -194583,9 +193952,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
registry_package:
type: object
properties:
@@ -194893,7 +194262,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *656
+ items: *651
summary:
type: string
tag_name:
@@ -194942,7 +194311,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -195029,10 +194398,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- release: &674
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: &669
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -195350,7 +194719,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -195437,11 +194806,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- release: *674
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *669
+ repository: *619
sender: *19
required:
- action
@@ -195568,11 +194937,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *621
- installation: *622
- organization: *623
- release: *674
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *669
+ repository: *619
sender: *19
required:
- action
@@ -195660,9 +195029,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
release:
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
@@ -195984,7 +195353,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -196070,10 +195439,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
- release: &675
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: &670
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -196392,7 +195761,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *624
+ repository: *619
sender: *19
required:
- action
@@ -196478,11 +195847,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *621
- installation: *622
- organization: *623
- release: *674
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *669
+ repository: *619
sender: *19
required:
- action
@@ -196568,11 +195937,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *621
- installation: *622
- organization: *623
- release: *675
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ release: *670
+ repository: *619
sender: *19
required:
- action
@@ -196658,10 +196027,10 @@ x-webhooks:
type: string
enum:
- anonymous_access_disabled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -196746,10 +196115,10 @@ x-webhooks:
type: string
enum:
- anonymous_access_enabled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -196834,10 +196203,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -196924,10 +196293,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197015,10 +196384,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197112,10 +196481,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197237,10 +196606,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197328,10 +196697,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197418,10 +196787,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197525,10 +196894,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -197608,10 +196977,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
repository_ruleset: *273
sender: *19
required:
@@ -197690,10 +197059,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
repository_ruleset: *273
sender: *19
required:
@@ -197772,10 +197141,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
repository_ruleset: *273
changes:
type: object
@@ -197837,16 +197206,16 @@ x-webhooks:
properties:
added:
type: array
- items: *529
+ items: *526
deleted:
type: array
- items: *529
+ items: *526
updated:
type: array
items:
type: object
properties:
- rule: *529
+ rule: *526
changes:
type: object
properties:
@@ -198090,10 +197459,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198181,10 +197550,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198272,7 +197641,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &676
+ alert: &671
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -198393,10 +197762,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198612,10 +197981,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198703,11 +198072,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *676
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *671
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -198916,10 +198285,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199007,7 +198376,7 @@ x-webhooks:
type: string
enum:
- created
- alert: &677
+ alert: &672
type: object
properties:
number: *93
@@ -199087,10 +198456,10 @@ x-webhooks:
description: 'The time that push protection was bypassed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
nullable: true
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199181,11 +198550,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *677
- installation: *622
- location: *678
- organization: *623
- repository: *624
+ alert: *672
+ installation: *617
+ location: *673
+ organization: *618
+ repository: *619
sender: *19
required:
- location
@@ -199428,11 +198797,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *677
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *672
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199520,11 +198889,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *677
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *672
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199612,11 +198981,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *677
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ alert: *672
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -199702,11 +199071,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- security_advisory: &679
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ security_advisory: &674
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -199899,11 +199268,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
- security_advisory: *679
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
+ security_advisory: *674
sender: *19
required:
- action
@@ -199986,10 +199355,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -200184,10 +199553,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *251
- enterprise: *621
- installation: *622
- organization: *623
- repository: *313
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *310
sender: *19
required:
- changes
@@ -200275,12 +199644,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: &680
+ sponsorship: &675
type: object
properties:
created_at:
@@ -200591,12 +199960,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- sponsorship
@@ -200694,12 +200063,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- changes
@@ -200786,17 +200155,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &681
+ effective_date: &676
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: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- sponsorship
@@ -200880,7 +200249,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &682
+ changes: &677
type: object
properties:
tier:
@@ -200924,13 +200293,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *681
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ effective_date: *676
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- changes
@@ -201017,13 +200386,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *682
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ changes: *677
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- sponsorship: *680
+ sponsorship: *675
required:
- action
- changes
@@ -201107,10 +200476,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -201203,10 +200572,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -201632,15 +201001,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *621
+ enterprise: *616
id:
description: The unique identifier of the status.
type: integer
- installation: *622
+ installation: *617
name:
type: string
- organization: *623
- repository: *624
+ organization: *618
+ repository: *619
sender: *19
sha:
description: The Commit SHA.
@@ -201752,12 +201121,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- team: &683
+ team: &678
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -201990,9 +201359,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -202450,7 +201819,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -202536,9 +201905,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -202996,7 +202365,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -203083,9 +202452,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -203543,7 +202912,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -203697,9 +203066,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -204157,7 +203526,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- changes
@@ -204245,9 +203614,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *621
- installation: *622
- organization: *623
+ enterprise: *616
+ installation: *617
+ organization: *618
repository:
title: Repository
description: A git repository
@@ -204705,7 +204074,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *683
+ team: *678
required:
- action
- team
@@ -204788,12 +204157,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- user: *643
+ user: *638
required:
- action
responses:
@@ -204871,12 +204240,12 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- user: *643
+ user: *638
required:
- action
responses:
@@ -204957,10 +204326,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
required:
- action
@@ -205043,16 +204412,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *621
+ enterprise: *616
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *622
- organization: *623
+ installation: *617
+ organization: *618
ref:
type: string
- repository: *624
+ repository: *619
sender: *19
workflow:
type: string
@@ -205144,10 +204513,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
allOf:
@@ -205384,7 +204753,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -205473,10 +204842,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
allOf:
@@ -205736,7 +205105,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -205825,10 +205194,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
type: object
@@ -205963,7 +205332,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -206052,10 +205421,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
workflow_job:
type: object
@@ -206191,7 +205560,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *428
+ deployment: *425
required:
- action
- repository
@@ -206281,12 +205650,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Workflow Run
type: object
@@ -207295,12 +206664,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ workflow: *633
workflow_run:
title: Workflow Run
type: object
@@ -208294,12 +207663,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *621
- installation: *622
- organization: *623
- repository: *624
+ enterprise: *616
+ installation: *617
+ organization: *618
+ repository: *619
sender: *19
- workflow: *638
+ {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}